Get a list of approval rules

GET
/buyers/{buyerID}/approvalrules

Roles

At least one of the roles below is required to access this endpoint

FullAccess
ApprovalRuleAdmin
ApprovalRuleReader

Parameters

NameTypeDescriptionPossible Values
buyerIDstringID of the buyer.---
searchstringWord or phrase to search for.---
searchOnarrayComma-delimited list of fields to search on.ID, Name, Description, RuleExpression
sortByarrayComma-delimited list of fields to sort by.Name, ID, ApprovingGroupID, RuleExpression, !Name, !ID, !ApprovingGroupID, !RuleExpression
pageintegerPage of results to return. Default: 1---
pageSizeintegerNumber of results to return per page. Default: 20, max: 100.---
filtersobjectAny additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'---

Response Body

PropertyTypeFormatMax LengthPossible Values
Itemsarray---------
PropertyTypeFormatMax LengthPossible Values
IDstring---------
Namestring---100 characters---
Descriptionstring---2000 characters---
ApprovingGroupIDstring---------
RuleExpressionstring---400 characters---

xpobject---------
Metaobject---------
PropertyTypeFormatMax LengthPossible Values
Pageintegerint32------
PageSizeintegerint32------
TotalCountintegerint32------
TotalPagesintegerint32------
ItemRangearray---------