GET
cURL

Authorizations

Authorization
string
header
required

JWT bearer token. App-user tokens are issued by POST /auth/token (the partner backend calls it as its platform service account); admin and dashboard tokens are issued via OIDC login.

Query Parameters

name
string | null

Case-insensitive prefix search over the user's name. A single token matches the first OR last name; two tokens match first AND last name (full-name search).

phone
string | null

Prefix search over the phone number (local number, without country code).

user_id
string | null

Prefix search over the 12-digit user id. Partial ids are accepted.

statuses
string | null
sort
null | object

Sort specification for list endpoints. Read the field names as "sort on <column> by <direction>".

time_range
null | object

A half-open time range, with a mandatory start and an optional end. Designed to be embedded in list/filter query params via #[serde(flatten)].

Deserialize runs [TimeRange::validate] as part of deserialization, so callers never receive a [TimeRange] that violates start_time <= end_time.

limit
integer<int32> | null
offset
integer<int32> | null

Response

List of users

data
object[]
required
limit
integer<int32>
required
offset
integer<int32>
required
total
integer<int64>
required