List contacts

GET/v1/contacts

Authorization

bearerAuth

AuthorizationBearer <token>

API token issued from the dashboard (Settings -> API Tokens). Sent as Authorization: Bearer <token>.

In: header

Query Parameters

limit?integer

Default25

Range1 <= value <= 100

skip?integer

Default0

Range0 <= value

query?string

Full-text match on name + email + phone.

Response Body

`application/json`

cURL

curl -X GET "https://example.com/contacts"

{
  "contacts": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "externalId": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "user@example.com",
      "phone": "+15558675309",
      "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
      "tags": [
        "string"
      ],
      "source": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}

Authorization

Query Parameters

Response Body

200application/json

`application/json`