Skip to navigation

Retrieve a paginated list of invoice approval policies

Beta
Returns a paginated list of invoice approval policies visible to the authenticated user. Used by partners to audit or sync policy configuration.

Authentication

AuthorizationBearer
OAuth2 authentication flows. Auth server URLs will vary by environment

Headers

X-Api-KeystringRequired
API key for authentication
X-API-VersionstringOptional

API version to use (optional, defaults to latest). Supported values: 1.0.0, 1.1.0.

Query parameters

pageintegerOptional>=1Defaults to 1
Page number, starting at 1. Requesting a page past the last one returns 404.
limitintegerOptional1-100Defaults to 20
Number of items per page
searchstringOptional
Search by policy name, purpose, or owner name
level_typestringOptional

Comma-separated owner scope: company, account, group, location, bank_account

is_enabledbooleanOptional

Filter enabled/disabled policies

ottimate_location_idintegerOptional

Filter to policies scoped to (owning) this location

has_missing_approverbooleanOptional

Filter to policies with (or without) a missing-approver warning — supports health-dashboard use cases

policy_setenumOptional

Which set of policies to list. Omitted returns single-scope policies only — what every existing integration receives today. advanced returns multi-scope policies, whose scope is reported in scope rather than in the single-scope fields.

Allowed values:
ottimate_company_idintegerOptional

Filter to policies scoped to (owning) this company

Response

Successful response with paginated policy list

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error