Order API - List customers

List Customers

Endpoint: GET *base*/customers
Authentication: API Key

Return list of the customers.

Parameters

limit
int
optional

Limit amount of customers returned.

offset
int
optional

Offset how far in to start returning customers.

email
string
optional

Return a specific customer.

created
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.

modified
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.

xml
boolean
optional

Response in xml format instead of json.

Request example

GET <base>/customers?limit=5&offset=5 HTTP/1.1

Response

200 Content-type: application/json

status
string
required

ok if success, else no.

customers
array
optional

Array of customers returned.

Response example

{
    "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"
        }
    ]
}

Previous article: Order API - Update stock
Next article: Order API - Get Customer