List contacts
List and search contacts for a profile. Supports filtering by tags, platform, subscription status, and text search on name, email and company.
Authorization
bearerAuth API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.
In: header
Query Parameters
Filter by profile. Omit to list across all profiles. Matches the profile recorded on the contact itself, which is set when the contact is created and is independent of the profile its account currently belongs to. Filter by accountId to list a contact through its channel instead.
Filter by the SocialAccount that owns the contact channel. Contacts are resolved through their channels, so the profileId contact filter is not applied while accountId is set. A profileId sent alongside is still access-checked and still scopes the returned filters.tags list.
Case-insensitive substring match on the contact name, email and company. Phone numbers and other platform identifiers are not matched: they live on the contact channel, not on the contact. To reach a contact from an inbox webhook, use the conversation.contactId it already carries.
Value in
- "instagram"
- "facebook"
- "telegram"
- "twitter"
- "bluesky"
- "reddit"
- "whatsapp"
- "slack"
- "sms"
Value in
- "true"
- "false"
value <= 200500Response Body
application/json
application/json
{ "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 }}