v2

latestOpenAPI 3.1.02026-08-075421692.0 MB
Contacts

List contacts

List and search contacts for a profile. Supports filtering by tags, platform, subscription status, and full-text search.

get/v1/contacts

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
tagstring
tagsstring

Comma-separated tags, matches contacts carrying any of them

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

Response

Contacts list with pagination and filter metadata

successboolean