Retrieve customers list

GET /customers

Retrieve customers list

cURL

curl --request GET \
  --url https://ywe3crmpll.execute-api.us-east-2.amazonaws.com/stage/customers \
  --header 'x-api-key: <api-key>'

200

{
  "error": false,
  "total_count": 10,
  "response": [
    {}
  ]
}

Authorizations

x-api-key · string · header · required

Query Parameters

sort_by · string

Allowed values: searchable, email, phone, address_1

sort_dir · string

Allowed values: asc, desc

limit · string

Defaults to 20 items per page, maximum 100 items allowed.

page · string

Page number. Starts from 1, defaults to 1.

search · string

Search string.

filter · string

Array of attribute, operator, and value parts.

asn · string

Array or object containing either a team_id index, assigned_members index containing an array of member ids, or both.

sort · string

Array of attribute and order values.

rel · string

array consisting of indices with the desired relation to include

calculate_count · string

true or false. If true, in response will be included also total count

Response

200

application/json

Successful response

error · boolean

false when the request succeeds.

Example:

false

total_count · integer

Total number of records that match the request, across all pages.

Example:

10

response · object[]