List pools
Returns all pools for the authenticated team.GET /v1/pools
Query parameters
integer
default:"1"
Page number.
integer
default:"25"
Results per page.
Create pool
Creates a new pool.POST /v1/pools
Headers
string
required
Your API key as a Bearer token:
Bearer {your_api_key}.string
required
Must be
application/json.Body parameters
string
required
Pool name. Min 2, max 255 characters. Must be unique per team.
string
Optional description of the pool.
string
Optional URL associated with the pool.
boolean
Whether this pool is the team’s default pool.
string[]
Array of network IDs to include in the pool.
string[]
Array of merchant IDs to add to the pool — bare ID, no
nmer_/mer_ prefix (see note below).Example request
Response 201
included_merchants[].id / excluded_merchants[].id are the merchant’s bare ID — no
nmer_/mer_ prefix, unlike the IDs GET /v1/merchants returns. To look one up directly,
prepend nmer_ (e.g. id: "01khfmw45fc139x9w8fsb133yb" →
GET /v1/merchants/nmer_01khfmw45fc139x9w8fsb133yb?extended=1). The merchants request
parameter (here, in Update, and in Pool merchants) takes
this same bare form.Get pool
Retrieves a single pool by its ULID.GET /v1/pools/{id}
Returns the same shape as the create response.
Update pool
Updates an existing pool.networks and merchants are diffed — IDs in the request replace the current set (new IDs are added, missing IDs are removed).
PUT /v1/pools/{id}
Body parameters
Same shape as create pool.200 with the same shape as the create response — included_merchants /
excluded_merchants, not merchants.
Delete pool
Deletes a pool by its ULID.DELETE /v1/pools/{id}