List customers¶
Order API v1
GET
*base*/customers
Authentication:API key
Return list of the customers.
Parameters¶
int
optional
|
Limit amount of customers returned. |
int
optional
|
Offset how far in to start returning customers. |
string
optional
|
Return a specific customer. |
date/datetime
optional
|
Get all customers added after a certain date. Allowed formats YYYY-mm-dd and YYYY-mm-dd HH:MM:SS . Timezone is system-wide and decided by the company using Centra. |
date/datetime
optional
|
Get all customers modified after a certain date. Allowed formats YYYY-mm-dd and YYYY-mm-dd HH:MM:SS . Timezone is system-wide and decided by the company using Centra. |
boolean
optional
|
Response in xml format instead of json. |
Request example¶
1 | GET <base>/customers?limit=5&offset=5 HTTP/1.1
|
Response¶
200
Content-type: application/json
string
required
|
ok if success, else no . |
array
required
|
Array of customers. The customer object is explained in Get Customer Parameters. |
Response example¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | {
"status": "ok",
"customers": [
{
"customerId": "1",
"email": "max.buch@example.com",
"firstName": "Max",
"lastName": "Buch",
"address1": "",
"address2": "",
"zipCode": "",
"city": "",
"state": "",
"country": "SE",
"phoneNumber": "",
"newsletter": true,
"gender": "",
"registered": false,
"consents": [
{
"key": "test_key1",
"name": "Consent1",
"consented": false,
"text": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industrys standard dummy text ever since the 1500s, when an unknown printer took a galley ",
"language": "",
"version": "",
"created": "2018-03-15 20:42:59",
"modified": "2018-03-15 20:42:59"
}
],
"created": "2018-03-15 20:42:59",
"modified": "2018-03-15 20:42:59"
},
{
"customerId": "6",
"email": "felix.parker@example.com",
"firstName": "Felix",
"lastName": "Parker",
"address1": "",
"address2": "Forest st. 102",
"zipCode": "95131",
"city": "San Jose",
"state": "CA",
"country": "US",
"phoneNumber": "",
"newsletter": false,
"gender": "",
"registered": true,
"consents": [],
"created": "2018-03-15 20:42:59",
"modified": "2018-03-15 20:42:59"
}
]
}
|