v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB
Point of Sale
customers
Customers

Get customers

Returns the list of customers

get/consumers/{consumer_id}/pos/customers

Path parameters

consumer_idstring uuid required

Query parameters

pageinteger

Page number

sizeinteger

Page size

searchstring nullable

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

emailstring nullable

Filter based on email of customer

phonestring nullable

Filter based on phone of customer

Response

Successful Response

totalinteger required
pageinteger required
sizeinteger required

Example response

{
  "items": [
    {
      "id": "371ca583-d218-8000-b236-397532cf0e52",
      "first_name": "John",
      "last_name": "Doe",
      "name": "John Doe",
      "phone": "+32475123456",
      "email": "john.doe@gmail.com",
      "created_on": "2025-01-01T00:00:00Z",
      "addresses": [
        {
          "address_type": "home",
          "name": "Home",
          "street": "Main Street",
          "number": "123",
          "box": "A",
          "city": "Paris",
          "postal_code": "75000",
          "country": "FR"
        }
      ],
      "loyalty": 100,
      "birthdate": "1990-01-01"
    }
  ]
}