Search Contacts

Tool name: search-contacts

Searches contact email and SMS channels by address, status, channel or tag (manual or smart tag), paginated by cursor. A contact with both channels appears twice. Phone queries need a country code; contact fields are available through get-contact.

Input schema

querynull or string, <= 250 characters

Case-insensitive fragment of an email address, or a mobile number with its country code; omit to match every contact

Default:null

statusnull or string

Subscription status to filter by; omit for every status

Default:null

Enum:"pending""optin""subscribed""unsubscribed"

tagIdnull or integer, >= 1

ID of a tag of the account the returned contacts must have, manual or smart tag

Default:null

channelnull or string

Restrict to one channel, email or sms; omit for both

Default:null

Enum:"email""sms"

cursornull or string, <= 500 characters

Opaque nextCursor value of the previous result page; omit for the first page

Default:null

pageSizeinteger, [ 1 .. 100 ]

Maximum contacts on the page, from 1 through 100

Default:25

accountIdnull or integer, >= 1

User ID of the account; omit for the account the access token works in

Default:null

Input example

{
  "query": null,
  "status": "pending",
  "tagId": null,
  "channel": "email",
  "cursor": null,
  "pageSize": 25,
  "accountId": null
}

Output schema

accountIdintegerrequired

pageSizeintegerrequired

countintegerrequired

hasMorebooleanrequired

nextCursorstring or nullrequired

contactsArray of objectsrequired

Output example

{
  "accountId": 0,
  "pageSize": 0,
  "count": 0,
  "hasMore": true,
  "nextCursor": "string",
  "contacts": [
    {
      "contactId": 0,
      "channel": "email",
      "contactInfo": "string",
      "email": "string",
      "subscriptionStatus": "string",
      "editUrl": "string"
    }
  ]
}