THthrivedesk
Contacts

List contacts

List contacts.

get/contacts

Request

  • Base URL
    https://api.thrivedesk.com/v1
  • Auth
    HTTP bearer

Query parameters

pageinteger
per_pageinteger
qstring

Search by name or email.

inboxstring

Only contacts with conversations in this inbox.

with_orphanboolean

Include contacts with no conversations.

Response

Success.

Example response

{
  "data": [
    {
      "id": "a2259012-556c-452c-ae91-e8d55e4107c0",
      "name": "Jane Cooper",
      "email": "jane@example.com",
      "avatar": null,
      "company": "Acme Inc",
      "website": "https://example.com",
      "job_title": "CTO",
      "address": null,
      "should_display_image": false,
      "notes": null,
      "conversations_count": 4
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 10,
    "per_page": 20,
    "to": 20,
    "total": 200,
    "path": "https://api.thrivedesk.com/v1/contacts"
  }
}

Changes

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