Skip to main content
GET
List contacts in a pool

Authorizations

Authorization
string
header
required

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

Path Parameters

uuid
string<uuid>
required

UUID of the pool whose members to list.

Query Parameters

page
integer
default:1

1-based page number. Default 1.

per_page
integer
default:25

Items per page. Default 25.

Case-insensitive partial match against the underlying contact's name, surname, email, or phone_number. Combine with status= to filter further.

status
enum<string>

Filter by ContactPoolItem status. Pending = waiting to be picked up. Processing/In_Call = currently being attempted. Retrying = failed once, awaiting retry window. Scheduled = queued for a specific future retry time. Completed/Failed/Skipped = terminal.

Available options:
Pending,
Processing,
Completed,
Failed,
Retrying,
Scheduled,
In_Call,
Skipped

Response

Paginated pool members.

success
boolean
Example:

true

message
string
Example:

"Pool contacts retrieved successfully"

data
object

Paginator payload.