List orders

⚠️ We no longer recommend using the Orders API. Please refer to the Payments API instead.

Retrieve all orders.

The results are paginated.

Access with

API key

Organization access token with orders.read

OAuth access with orders.read

Query Params
string

Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.

integer | null
1 to 250
Defaults to 50

The maximum number of items to return. Defaults to 50 items.

string

Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.

Possible values: asc desc

string

The identifier referring to the profile you wish to retrieve orders for.

Most API credentials are linked to a single profile. In these cases the profileId is already implied.

To retrieve all orders across the organization, use an organization-level API credential and omit the profileId parameter.

boolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Responses

Language
Credentials
Request
Response
Choose an example:
application/hal+json