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.

Path Parameters

user_id
string
required

User ID

Query Parameters

relationship
null | enum<string>

Relationship of a dependant to the primary user.

Available options:
SELF,
SPOUSE,
MOTHER,
FATHER,
CHILD,
FATHER_IN_LAW,
MOTHER_IN_LAW,
SIBLING
sort
null | object

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

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

Response

List of dependants

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