Contacts

List contacts

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

Billing: Read (free unless it says otherwise) · Rate limit: 120/min

get/v1/messaging/contacts

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/messaging/contacts
  • Auth: HTTP bearer

Query parameters

tagstring
skipinteger
tagsstring

Comma-separated tags, matches contacts carrying any of them

limitinteger
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.

platform'instagram' | 'facebook' | 'telegram' | 'twitter' | 'bluesky' | 'reddit' | 'whatsapp' | 'slack' | 'sms'
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.

isSubscribed'true' | 'false'

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

Response

Completed

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.