Skip to main content
GET
Retrieve a paginated list of contacts

Authorizations

x-api-key
string
header
required

Headers

x-api-key
string
required

API key for authentication

Query Parameters

page
integer
default:1

Page number for pagination

Required range: x >= 1
pageSize
integer
default:10

Number of items per page

Required range: 1 <= x <= 100
name
string

Filter contacts by partial name match (case-insensitive)

email
string

Filter contacts by partial email match (case-insensitive)

channel
enum<string>

Filter contacts by exact channel match

Available options:
whatsapp,
email
identifier
string

Filter contacts by partial identifier match (case-insensitive)

Response

Successfully retrieved contacts

contacts
object[]
totalCount
integer
currentPage
integer
pageSize
integer
totalPages
integer