Contacts

Search contacts

Search the org's contact records — one person per number, across every audience. Returns consent, opt-out, the number verdict, marketing status, merge fields and tags.

get/contacts

Request

  • Base URL: https://rcs-templates-api-dot-msg2ai-server.ue.r.appspot.com/api/agent
  • URL: https://rcs-templates-api-dot-msg2ai-server.ue.r.appspot.com/api/agent/contacts
  • Auth: HTTP bearer

Query parameters

qstring

Free-text over number, names and email.

status'SUBSCRIBED' | 'UNSUBSCRIBED' | 'UNDELIVERABLE' | 'UNKNOWN'

Marketing status: SUBSCRIBED (consent, not opted out), UNSUBSCRIBED (opted out — sticky), UNDELIVERABLE (number known unreachable), UNKNOWN (no consent on record).

tagstring
audienceIdstring

Only people who are members of this audience.

pagenumber
pageSizenumber

Response

Success.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.