List customers

Returns a collection of customers.

Filtering — ?filter[id]=1,2,3, ?filter[email][email protected], ?filter[external_identifier]=crm-4711.

AuthorizationbearerAuth

Authorization

bearerAuth

AuthorizationBearer <token>

OAuth2 access token — how to obtain one is described under Setup → Authentication.

In: header

Query Parameters

page?integer

Page number — see Basic Usage → Pagination.

Default1

filter[email]?string

Formatemail

filter[external_identifier]?string

Header Parameters

Accept*"application/json"

The API only responds with JSON — this header is mandatory on every request (see Setup → Headers).

Default"application/json"

Value in

"application/json"

Response Body

`application/json`

Request example

curl -X GET "https://example.com/customers" \  -H "Accept: application/json"

{  "data": [    {      "id": 0,      "email": "[email protected]",      "first_name": "string",      "last_name": "string",      "external_identifier": "string",      "created_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "current_page": 0,    "per_page": 0,    "total": 0  }}