Skip to main content
List purchase orders

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Query Parameters

fields
string[]

Return only these fields of each row; use dots for nested fields, such as approvers.user_id. id is always returned. Fields: company_id, id, number, title, status, awaiting_approval, approvers, archived, supplier, buyer, owner_user_id, agreement, currency_code, commitment_basis, totals, billing, revision, open_alert_count, valid_until, origin, source, from_import, created_at, updated_at.

Order number, the other system's number (source.number) or title.

Required string length: 1 - 200
source_system
string

Only orders linked to this other system (source.system).

Required string length: 1 - 50
source_ids
string[]

Only orders with these IDs in their other system (source.id).

Required string length: 1 - 200
statuses
enum<string>[]
Available options:
draft,
open,
closed,
cancelled
awaiting_approval
boolean

true lists only orders waiting for approval, false only the others.

supplier_ids
string<uuid>[]
company_ids
string<uuid>[]

Only orders these workspace companies placed.

Required array length: 1 - 1000 elements
buyer_ids
string<uuid>[]

Recipient IDs: the legal entities that placed the orders.

owner_user_ids
string[]
Required string length: 1 - 200
Pattern: ^[A-Za-z0-9_-]+$
assigned
enum<string>

me: orders the caller owns, and orders whose pending approval request asks the caller to approve, by name or through a team they are in.

Available options:
me
agreement_ids
string[]
archived
boolean

true lists only archived orders; by default they are left out.

has_invoices
boolean

true lists only orders with an accepted invoice (billing.linked_invoices above 0), false only those without.

limit
integer
default:50
Required range: 1 <= x <= 1000
cursor
string
Maximum string length: 4096
sort
enum<string>
default:created_at

company sorts by company name; checks by open_alert_count; billed by billing.billed over totals.commitment. Drafts sort last by checks and billed, as do orders without an accepted invoice or a commitment by billed.

Available options:
created_at,
updated_at,
number,
supplier,
buyer,
company,
status,
commitment,
checks,
billed
direction
enum<string>
default:desc
Available options:
asc,
desc

Response

A page of purchase orders; next_cursor is null at the end.

data
object[]
required
Maximum array length: 1000
next_cursor
string | null
required