List

Returns a list of customers.

Request

The "Authorization" header for this API method contains an <access_token> placeholder. Replace it with the value of an actual access token.

Name

Value

Authorization

Bearer <access_token>

URL

Parameters

Name

Allowed values

Required

page

(An integer greater than 0, default: 1)

No

page_size

(An integer between 1 and 1000, default: 25)

No

sort

(A valid sort value, see table below, default: "fullname")

No

Allowed sort values:

Value

Description

fullname

Sorts on fullname, ascending.

-fullname

Sorts on fullname, descending.

Response

Headers

Name

Value

Status code

200

Status message

OK

Example

{
"meta": {
"count": 158
},
"success": true,
"customers": [
{
"country": "United States",
"fullname": "John Appleseed"
"created_at": "2018-04-01T00:00:00Z",
"gender": "man",
"id": 1234,
"city": "Cupertino",
"updated_at": "2018-04-02T00:00:00Z",
"age": "30",
"email": "appleseed@example.com"
}
]
}

Get

Returns a customer

Request

Headers

De "Authorization" header voor deze API methode bevat een <access_token> plaatshouder. Vervang deze met de waarde van een echte access token.

Name

Value

Authorization

Bearer <access_token>

URL

The endpoint for this API method contains an <id> placeholder. Replace it with the value of an actual customer id.

Response

Headers

Name

Value

Status code

200

Status message

OK

Example

{
"success": true,
"customer": {
"country": "United States",
"fullname": "John Appleseed",
"created_at": "2018-04-01T00:00:00Z",
"gender": "man",
"id": 1234,
"city": "Cupertino",
"updated_at": "2018-04-02T00:00:00Z",
"age": "30",
"email": "appleseed@example.com"
}
}
Heeft u het antwoord gevonden?