contacts
List contacts
List and search contacts for a profile. Supports filtering by tags, platform, subscription status, and full-text search.
AuthorizationBearer <token>
API key authentication - use your Zernio API key as a Bearer token
In: header
Query Parameters
profileId?string
Filter by profile. Omit to list across all profiles
search?string
tag?string
platform?string
Value in
"instagram" | "facebook" | "telegram" | "twitter" | "bluesky" | "reddit" | "whatsapp"isSubscribed?string
Value in
"true" | "false"limit?integer
Default
50Range
value <= 200skip?integer
Default
0Response Body
application/json
application/json
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.contacts.listContacts();console.log(data);{
"success": true,
"contacts": [
{
"id": "string",
"name": "string",
"email": "string",
"company": "string",
"avatarUrl": "string",
"tags": [
"string"
],
"isSubscribed": true,
"isBlocked": true,
"lastMessageSentAt": "2019-08-24T14:15:22Z",
"lastMessageReceivedAt": "2019-08-24T14:15:22Z",
"messagesSentCount": 0,
"messagesReceivedCount": 0,
"customFields": {},
"notes": "string",
"createdAt": "2019-08-24T14:15:22Z",
"platform": "string",
"platformIdentifier": "string",
"displayIdentifier": "string"
}
],
"filters": {
"tags": [
"string"
]
},
"pagination": {
"total": 0,
"limit": 0,
"skip": 0,
"hasMore": true
}
}{
"error": "Unauthorized"
}