Automations · Contacts
Returns contacts, one page at a time.
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the contacts resource group disabled get 403 resource_group_disabled. Authentication
Query parameters
| Name | Type | Notes |
|---|---|---|
profileId | string | |
accountId | string | |
search | string | |
tag | string | |
tags | string | |
platform | string | One of instagram, facebook, telegram, twitter, bluesky, reddit, whatsapp, slack, sms |
isSubscribed | string | One of true, false |
limit | integer | Default 50At most 200 |
skip | integer | Default 0 |
Example
curl -X GET "https://api.pozy.ai/v1/contacts?limit=50" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/contacts?limit=50", {
headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.get(
"https://api.pozy.ai/v1/contacts",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
params={
"limit": 50,
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
successbooleancontactsarray of object18 child fields
idstringnamestringemailstringcompanystringavatarUrlstringtagsarray of stringisSubscribedbooleanisBlockedbooleanlastMessageSentAtstring (date-time)lastMessageReceivedAtstring (date-time)messagesSentCountintegermessagesReceivedCountintegercustomFieldsobjectnotesstringcreatedAtstring (date-time)platformstringplatformIdentifierstringdisplayIdentifierstring
filtersobjecttagsarray of string
paginationobjecttotalintegerlimitintegerskipintegerhasMoreboolean
200 response
{
"success": true,
"contacts": [
{
"id": "6bfebd43ddc270f6d2c56fc5",
"name": "Acme",
"email": "alex@example.com",
"company": "string",
"avatarUrl": "https://pozy.ai/media/example-1.jpg",
"tags": [
"string"
],
"isSubscribed": true,
"isBlocked": true,
"lastMessageSentAt": "2026-10-02T09:00:00.000Z",
"lastMessageReceivedAt": "2026-10-02T09:00:00.000Z",
"messagesSentCount": 42,
"messagesReceivedCount": 42,
"customFields": {},
"notes": "string",
"createdAt": "2026-10-02T09:00:00.000Z",
"platform": "instagram",
"platformIdentifier": "instagram",
"displayIdentifier": "string"
}
],
"filters": {
"tags": [
"string"
]
},
"pagination": {
"total": 42,
"limit": 1,
"skip": 1,
"hasMore": true
}
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is scoped to other profiles or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.