Skip to main content
GET
List purchase orders
A client’s authorization to bill up to a set amount. Projects, invoices, and credit notes can be tied to a purchase order to track how much of it is used.

Authorizations

Authorization
string
header
required

An API key created in Settings > API Keys. Each key is either Read-Only or Full Access, chosen when the key is created. A Read-Only key can only make GET requests; POST, PATCH, and DELETE requests made with it return a 403 with the message This API key is read-only.

Query Parameters

startingAfter
string

A cursor ID (uuid) used to request the next page of results. If not provided, defaults to the first page of results.

endingBefore
string

A cursor ID (uuid) used to request the previous page of results. Is mutually exclusive with startingAfter.

limit
integer

The maximum number of results to be returned. Can be any number from 1 to 100. Defaults to 10, if not provided.

clientId
string

A client ID (uuid) used to filter objects for a specific client.

currency
string

An ISO 4217 currency code used to filter objects by currency.

isActive
enum<string>

Filter purchase orders by whether they are active.

Available options:
true,
false
startOnBefore
string

Return purchase orders that start on or before this date (YYYY-MM-DD), including those with no start date.

endOnAfter
string

Return purchase orders that end on or after this date (YYYY-MM-DD), including those with no end date.

Response

200

results
object[]

The list of results for the current page.

hasMore
boolean

Whether there are more results available after this page.