GET
The operator's queue view.

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

benefit_entity_id
string | null
benefit_provider_id
string | null
name
string | null
phone
null | object
mrn
string | null
statuses
string | null
entity_types
string | null
user_id
null | string

A validated 12-digit numeric user identifier.

Every external entry point validates:

  • JSON Deserialize runs [UserId::parse] (outer whitespace trimmed, length and digit-only enforced) via #[serde(try_from = "String")].
  • DB FromSql runs [UserId::parse] on every row read.

Display / Deref<Target = str> / AsRef<str> / Into<String> are derived via derive_more — the inner String is pass-through for every read-only borrow, display, and move-out.

Example:

"012345678901"

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

Paginated clinic queue. A tenant-scoped caller sees only its own provider's rows, whatever benefit_provider_id it passed.

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