Get a list of loyalty customers
Get a paginated list of customers from a loyalty service through an external loyalty API.
⚠️ Not supported by Como services.
This setting can be found in the Third-Party settings in POS API via /v2/third-party/.
GET
/v1/customers/authorization<token>
To get an API key, please contact us. We'll be happy to help you.
In: header
Query Parameters
pagenumber
Page number to fetch
page_sizenumber
Number of customers to fetch
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:4010/v1/customers/?page=0&page_size=0"{
"customers": [
{
"id": "c49f95c8-8fd6-4ab5-8a01-e56c8fdd916d",
"firstName": "John",
"lastName": "Doe",
"email": "john@doe.com",
"phoneNumber": "+33601020304",
"birthDate": "2000-01-01T00:00:00.000Z",
"hasOptinSms": true,
"hasOptinEmail": null,
"externalLoyaltyId": "external-loyalty-id-12345"
},
{
"id": "a0533e33-ed78-4ad9-8a5e-432f883e6f3b",
"firstName": "Jane",
"lastName": "Doe",
"email": "jane@doe.com",
"phoneNumber": "+33602020202",
"birthDate": "2000-01-01T00:00:00.000Z",
"hasOptinSms": null,
"hasOptinEmail": true,
"externalLoyaltyId": "external-loyalty-id-12345"
}
],
"pages": {
"previous": null,
"next": "{API_URL}/v1/customers?page=2&page_size=2",
"list": [
null,
"{API_URL}/v1/customers?page=1&page_size=2",
"{API_URL}/v1/customers?page=2&page_size=2",
"{API_URL}/v1/customers?page=3&page_size=2"
]
},
"count": 5
}{
"code": "CUSTOMER_LIST_PARAMS_NOT_VALID",
"message": "Customer list params are invalid."
}{
"code": "UNEXPECTED_ERROR",
"message": "Internal server error"
}{
"code": "NOT_IMPLEMENTED",
"message": "This method is not implemented."
}