ConvertedIn | DOCS
Search…
Customers
Retrieve a list of customers.

Request

curl -X GET "{domain}/api/customers?page=1&limit=100" \
-H "Access-Token: {access_token}"

Parameters

Name
Type
Required
Description
page
int
true
page number
limit
int
true
count items per page

Response

{
"data": [
{
"id": 207119551,
"email": "[email protected]",
"accepts_marketing": false,
"created_at": "2021-10-01T16:52:26-04:00",
"updated_at": "2021-10-01T16:52:26-04:00",
"first_name": "Bob",
"last_name": "Norman",
"orders_count": 1,
"state": "disabled",
"total_spent": "199.65",
"last_order_id": 450789469,
"verified_email": true,
"phone": "+16136120707",
"last_order_name": "#1001",
"currency": "USD",
"addresses": [
{
"id": 207119551,
"customer_id": 207119551,
"first_name": null,
"last_name": null,
"company": null,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"province": "Kentucky",
"country": "United States",
"zip": "40202",
"phone": "555-625-1199",
"name": "",
"province_code": "KY",
"country_code": "US",
"country_name": "United States",
"default": true
}
],
"default_address": {
"id": 207119551,
"customer_id": 207119551,
"first_name": null,
"last_name": null,
"company": null,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"province": "Kentucky",
"country": "United States",
"zip": "40202",
"phone": "555-625-1199",
"name": "",
"province_code": "KY",
"country_code": "US",
"country_name": "United States",
"default": true
}
}
],
"total": 1000,
"per_page": 100,
"current_page": 1,
"last_page": 10,
"from": 1,
"to": 100
}
Copy link
Outline
Request
Parameters
Response