Skip to main content
GET
/
consumers
/
{consumer_id}
/
pos
/
customers
Get customers
curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/pos/customers
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "first_name": "John",
      "last_name": "Doe",
      "phone": "+32475123456",
      "email": "john.doe@gmail.com",
      "created_on": "2025-01-01T00:00:00Z",
      "addresses": [],
      "loyalty": 100,
      "birthdate": "1990-01-01"
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2
}

Path Parameters

​
consumer_id
string<uuid>
required

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
size
integer
default:50

Page size

Required range: 1 <= x <= 100
​
search
string | null

Filter based on other parameters than the email/phone, e.g. firstname, lastname

​
email
string | null

Filter based on email of customer

​
phone
string | null

Filter based on phone of customer

Response

Successful Response

​
items
POSCustomerItem · object[]
required
​
total
integer
required
Required range: x >= 0
​
page
integer
required
Required range: x >= 1
​
size
integer
required
Required range: x >= 1