Get customers

curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/pos/customers \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "first_name": "John",
      "last_name": "Doe",
      "phone": "+32475123456",
      "email": "[email protected]",
      "created_on": "2025-01-01T00:00:00Z",
      "addresses": [],
      "loyalty": 100,
      "birthdate": "1990-01-01"
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2
}

GET

consumers

{consumer_id}

pos

customers

Get customers

curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/pos/customers \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "first_name": "John",
      "last_name": "Doe",
      "phone": "+32475123456",
      "email": "[email protected]",
      "created_on": "2025-01-01T00:00:00Z",
      "addresses": [],
      "loyalty": 100,
      "birthdate": "1990-01-01"
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2
}

Authorizations

Authorization

string

header

required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

consumer_id

string<uuid>

required

Query Parameters

page

integer

default:1

Page number Page number

Required range: x >= 1

size

integer

default:50

Page size Page size

Required range: 1 <= x <= 100

string | null

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

string | null

Filter based on email of customer

phone

string | null

Filter based on phone of customer

Response

Successful Response

items

POSCustomerItem · object[]

required

Show child attributes

items.id

string

required

Unique identifier of the customer

items.name

string

required

Name (first name + last name) of the customer

items.first_name

string | null

First name of the customer

Example:

"John"

items.last_name

string | null

Last name of the customer

Example:

"Doe"

items.phone

string | null

Phone number (mobile, home, work, ...) of the customer

Example:

"+32475123456"

items.email

string | null

Email address of the customer

Example:

"[email protected]"

items.created_on

string<date-time> | null

Date and time when the customer was created

Example:

"2025-01-01T00:00:00Z"

items.addresses

AddressItem · object[] | null

List of addresses of the customer

Show child attributes

items.addresses.address_type

string | null

Type of the address

Example:

"home"

items.addresses.name

string | null

Name given to the address (e.g. 'home')

Example:

"Home"

items.addresses.street

string | null

Street name

Example:

"Main Street"

items.addresses.number

string | null

Number of the address

Example:

"123"

items.addresses.box

string | null

Box of the address

Example:

"A"

items.addresses.city

string | null

City name

Example:

"Paris"

items.addresses.postal_code

string | null

Postal code of the address

Example:

"75000"

items.addresses.country

string | null

Country, format: ISO 3166-1 codes.

Example:

"FR"

items.loyalty

integer | null

Loyalty points of the customer

Example:

100

items.birthdate

string<date> | null

Birthdate of the customer

Example:

"1990-01-01"

total

integer

required

Required range: x >= 0

page

integer

required

Required range: x >= 1

size

integer

required

Required range: x >= 1

Get accounting categories Create one customer

⌘I

API Reference Overview

Access & Connections

Accounting

Invoicing

POS

eCommerce

PMS

Payment

Banking

Other

Get customers

Authorizations

Path Parameters

Query Parameters

Response