Skip to main content
GET
List contact pools

Authorizations

Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Query Parameters

page
integer
default:1

1-based page number. Default 1.

per_page
integer
default:15

Items per page. Default 15.

Case-insensitive partial match against pool name, description, or type.

type
enum<string>

Filter by processing order. FIFO = oldest pending first; LIFO = newest pending first; Parallel = up to max_parallel_items concurrent, priority-ordered.

Available options:
FIFO,
LIFO,
Parallel
is_active
boolean

Filter by active flag. Inactive pools cannot be selected by new campaigns.

Response

200 - application/json

Paginated list of pools. Each row includes contacts_count (no per-row status breakdown — use GET /pools/{uuid} for that).

success
boolean
Example:

true

message
string
Example:

"Pools retrieved successfully"

data
object

Paginator payload.