Skip to main content
GET
Get all customers

Yetkilendirmeler

Authorization
string
header
gerekli

The access token received from the authorization server in the OAuth 2.0 flow.

Başlıklar

X-Tenant
number
gerekli

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Sorgu Parametreleri

search
string | null

The search query.

Maximum string length: 255
per_page
integer | null

The number of items per page.

Gerekli aralık: 1 <= x <= 100
page
integer | null

The page number.

Gerekli aralık: x >= 1
sort_by
enum<string> | null

The field to sort by.

Mevcut seçenekler:
first_name,
last_name,
date_of_birth,
gender,
created_at,
updated_at,
null
sort_order
enum<string> | null

The sort direction (asc or desc).

Mevcut seçenekler:
asc,
desc,
null
gender
enum<string> | null

Filter by gender.

Mevcut seçenekler:
male,
female,
other,
null
min_age
integer | null

Filter by minimum age.

Gerekli aralık: x >= 0
max_age
integer | null

Filter by maximum age.

Gerekli aralık: x >= 0
user_id
integer | null

Filter by assigned user.

occupation_id
integer | null

Filter by occupation.

created_at_from
string<date-time> | null

Filter records created at or after this date (inclusive, YYYY-MM-DD).

created_at_to
string<date-time> | null

Filter records created at or before this date (inclusive, YYYY-MM-DD).

date_of_birth_from
string<date-time> | null

Filter records with a birth date on or after this date (inclusive, YYYY-MM-DD).

date_of_birth_to
string<date-time> | null

Filter records with a birth date on or before this date (inclusive, YYYY-MM-DD).

tags[]
integer[]

A tag ID to filter by.

has_email
boolean | null

Filter by e-mail presence. Pass 1 for customers that have an e-mail address, 0 for those that do not. A blank e-mail counts as missing.

exclude_erased
boolean | null

Pass 1 to leave out patients whose data was erased (right to erasure). Off by default so lists and history keep showing the masked records; use it for pickers that start new work (appointment form, sale form).

Yanıt

Paginated set of CustomerResource

data
CustomerResource · object[]
gerekli
meta
object
gerekli