Approval Policies

GET /base/approval-policies

Group: Base › Approval Policies · Operation ID: approvalPolicies

Returns a list of approval policies, each as its header only. Use GET base/approval-policies/:id or POST base/approval-policies/search for the rule lines, approvers and notification settings.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
policyHeaderNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
businessObject — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
status — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
isAllEntities — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
startDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
endDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, policyHeaderNumber, businessObject, status, startDate, endDate, lastModifiedDate
Selectable: id, policyHeaderNumber, businessObject, status, isAllEntities, entityName, startDate, endDate, submitterCannotApprove, approverCommentEnabled, lastModifiedDate

Response

200 Success

Under data, an array of approvalPoliciesRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the approval policy.
`policyHeaderNumber`	string or null	no	The policy number, assigned when the policy is created and stable across edits.
`businessObject`	string or null	no	The code of the business object the policy governs, for example 'VendorBill', 'ExpenseReport' or 'PurchaseOrder'.
`status`	string or null	no	The lifecycle status of the policy. Possible values: 'active', 'inActive'. Only active policies are matched against new documents. Documents already in flight keep approving against an inActive policy.
`isAllEntities`	boolean or null	no	Whether the policy applies to every legal entity rather than the one named by entityName.
`entityName`	string or null	no	The name of the legal entity the policy applies to. Absent when isAllEntities is true.
`startDate`	string (date) or null	no	The first date the policy is eligible for matching. Format YYYY-MM-DD. Absent when there is no lower bound.
`endDate`	string (date) or null	no	The last date the policy is eligible for matching. Format YYYY-MM-DD. Absent when there is no upper bound.
`submitterCannotApprove`	boolean or null	no	Whether the document submitter is stopped from approving their own document. When true, their approval does not count toward fulfillment and they are not notified as an approver.
`approverCommentEnabled`	boolean or null	no	Whether approvers are prompted for an optional comment at approve time. The comment is stored on the approval trail.
`lastModifiedDate`	string (date-time) or null	no	The date and time the approval policy last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error