Skip to main content
GET
List contacts

Authorizations

X-API-Key
string
header
required

API key for external access. Format: tp_live_<32-hex-chars>. Create keys in the TalkPilot Dashboard under Settings > API.

Path Parameters

agentId
string<uuid>
required

Agent UUID

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:20

Items per page

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

Exact E.164 number; matches any of the three number fields

Example:

"+491711234567"

tag
string

Only contacts carrying this tag (exact, case-sensitive)

Example:

"vip"

Case-insensitive substring search over customer_name, company, email and the number fields

Response

List of contacts

data
object[]
pagination
object