Skip to main content
GET
List customer orders

Authorizations

Authorization
string
header
required

API key sent in the Authorization header.

Path Parameters

customer_id
string<uuid>
required

The customer (child org) ID. Must belong to the caller's organization or a direct child.

Response

Paginated orders

A page of orders.

items
object[]
required

The items on this page.

pageNumber
integer
required

Zero-based index of this page.

Required range: x >= 0
Example:

0

pageSize
integer
required

Number of items per page.

Required range: x >= 0
Example:

30

totalItems
integer
required

Total number of items across all pages.

Required range: x >= 0
Example:

42

totalPages
integer
required

Total number of pages.

Required range: x >= 0
Example:

2

next
string | null

URL to fetch the next page of results, if available.