Skip to main content
GET
Pools

Authorizations

X-API-Key
string
header
required

Your API key from the Studio Dashboard

Query Parameters

page
integer
default:1

Page number, 1-indexed.

Required range: x >= 1
page_size
integer
default:50

Items per page. Default 50, max 100.

Required range: 1 <= x <= 100
status
enum<string>

Filter by pool status.

Available options:
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.

Required range: 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.

Required range: x >= 0
sort
enum<string>
default:created_at_desc

Sort order.

Available options:
created_at_desc,
created_at_asc,
updated_at_desc,
start_date_desc,
start_date_asc

Response

Successful response

success
boolean
Example:

true

data
object[]
pagination
object

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