Skip to main content
GET
List the resources of a pool

Authorizations

client_id
string
header
required
secret_key
string
header
required

Path Parameters

poolId
string<uuid>
required

Query Parameters

page
integer
default:1
pageSize
integer
default:20
Required range: x <= 100
orderBy
enum<string>
default:createdAt

Field to sort by. Defaults to createdAt.

Available options:
externalCode,
createdAt,
updatedAt
order
enum<string>
default:desc

Sort direction. Defaults to desc.

Available options:
asc,
desc
createdAtFrom
string<date-time>

Inclusive lower bound for createdAt (ISO 8601).

createdAtTo
string<date-time>

Inclusive upper bound for createdAt (ISO 8601).

updatedAtFrom
string<date-time>

Inclusive lower bound for updatedAt (ISO 8601).

updatedAtTo
string<date-time>

Inclusive upper bound for updatedAt (ISO 8601).

Case-insensitive partial match on the resource external code.

Minimum string length: 1
status

Filter by one or more statuses. Repeat the parameter or pass a comma-separated list.

Available options:
available,
reserved,
active,
suspended,
quarantined,
decommissioned
typeId

Filter by one or more resource types. Repeat the parameter or pass a comma-separated list.

brokerId

Filter by one or more brokers (partners). Repeat the parameter or pass a comma-separated list.

attributes
string

JSON object of attributes to match exactly, e.g. {"uf":"SP"}.

Response

200 - application/json

Default Response

items
object[]
required
meta
object
required