Show Developer Menu

GET /contacts

Issuing a GET call to contacts will allow you to retrieve contacts for the Account. Note that unlike other resources, contacts are tied to the account, not the individual brand.

Example Request
curl 'https://{brand}' \
  -u {login-email}:{api-token} \
  -H 'Accept: application/json'
Example Response
  "page_size": 30,
  "page_count": 1,
  "total_count": 10,
  "contacts": [
      "name": "John Doe",
      "email": "",
      "friendly_name": "Johnny",
      "notes": [{"id": 1, "note": "this is a note", "created_at": ...}, ...]
Optional Params
  • q with any string will search over contacts by name or email
  • data with a hash of key/value pairs (e.g. data[key]=value) will return contacts with data matching those key/value pairs.
  • sort with value set to date will return results in descending order of create time. The default sort when this parameter is not provided is by name.
  • type with values set to email or mobile will return only contacts that have an email address or phone number, respectively.
  • page with any number will allow you to paginate through results. page_size and page_count are provided by the result.