Skip to main content
GET
Get customers

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