Skip to main content
POST
Query inventory allocations

Authorizations

X-API-Key
string
header
required

Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.

Body

application/json

The same options the list endpoint takes in the query string. Any additional key is read as a field filter.

filter
string

AND/OR filter expression.

Full-text search term.

page
integer
default:1

Page to return, starting at 1.

pageSize
integer
default:100

Records per page. Defaults to 100 when omitted.

orderBy

Sort as field:asc or field:desc.

select
string[]

Return only these fields.

Field name.

Response

Successful response.

values
object[]
hasMore
boolean