Contacts

List and search contacts for a profile. Supports filtering by tags, platform, subscription status, and text search on name, email and company.

get/v1/contacts

Request

  • Base URL: https://zernio.com/api
  • URL: https://zernio.com/api/v1/contacts
  • Auth: HTTP bearer

Query parameters

profileIdstring

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.

accountIdstring

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.

searchstring

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.

tagstring
tagsstring

Comma-separated tags, matches contacts carrying any of them

platform'instagram' | 'facebook' | 'telegram' | 'twitter' | 'bluesky' | 'reddit' | 'whatsapp' | 'slack' | 'sms'
isSubscribed'true' | 'false'
limitinteger
skipinteger

Response

Contacts list with pagination and filter metadata

successboolean

Changes

    • warning

      added the new account enum value to the / response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status