Skip to main content
GET
Get paginated list of contacts

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer
default:1

Page number

per_page
integer
default:15

Number of items per page

Search term for name, email, or phone

status
enum<string>

Filter by contact status

Available options:
Active,
Inactive
contact_channel
enum<string>

Filter by preferred contact channel

Available options:
Call,
SMS,
WhatsApp
stage_uuid
string<uuid>

Filter by the contact's current pipeline stage UUID

campaign_uuid
string<uuid>

Filter by campaign UUID (matches contacts whose pool is attached to this campaign)

tag_uuid
string<uuid>

Filter by tag UUID

pool_uuid
string<uuid>

Filter by contact pool UUID

date_from
string<date>

Filter contacts created on or after this date (Y-m-d)

date_to
string<date>

Filter contacts created on or before this date (Y-m-d)

Response

Success

success
boolean

Indicates whether the request completed successfully. True for successful responses; false for documented error responses.

Example:

true

message
string

Human-readable response message. Safe to display in logs or simple client notifications; use structured fields for program logic.

Example:

"Contacts retrieved successfully"

data
object