Skip to main content
GET
Pools

Авторизации

X-API-Key
string
header
обязательно

Your API key from the Studio Dashboard

Параметры запроса

page
integer
по умолчанию:1

Page number, 1-indexed.

Требуемый диапазон: x >= 1
page_size
integer
по умолчанию:50

Items per page. Default 50, max 100.

Требуемый диапазон: 1 <= x <= 100
status
enum<string>

Filter by pool status.

Доступные опции:
active,
paused,
completed,
archived
since_changed_at
integer

Delta-sync filter. Return only rows whose changed_at is at or after this UNIX timestamp. Pair with until_changed_at for a window.

Требуемый диапазон: x >= 0
until_changed_at
integer

Delta-sync filter. Return only rows whose changed_at is strictly before this UNIX timestamp. Useful to lock the upper bound while paginating an open delta range.

Требуемый диапазон: x >= 0
sort
enum<string>
по умолчанию:created_at_desc

Sort order.

Доступные опции:
created_at_desc,
created_at_asc,
updated_at_desc,
start_date_desc,
start_date_asc

Ответ

Successful response

success
boolean
Пример:

true

data
object[]
pagination
object

Page-based pagination, returned by every list endpoint that isn't a cursor feed.