Skip to main content
GET
List allocations

Authorizations

Api-Access-Key
string
header
required

An API key associated with a security role

Path Parameters

accountId
string<uuid>
required

Account ID (a UUID) to list allocations for. Must not be a subaccount ID.

Example:

"3486b413-93d3-4447-afce-2b9c9dc34a32"

Query Parameters

after
string

When paginating this is used to provide the starting point for the page to fetch (retrieved from the previous response body)

Minimum string length: 1
limit
integer<int64>
default:100

Maximum number of results to return per query

Required range: 1 <= x <= 1000
orderIds
string<uuid>[]

Filter to the allocations of these order IDs, as a comma-separated list of UUIDs. When omitted, allocations across all of the account's orders are returned.

Response

List of subaccount-scoped orders (allocations).

data
Order · object[]
required
page
Page · object
required

Pagination info