GET
/
users
/
{user_id}
/
dependants
cURL
curl --request GET \
  --url http://localhost:8080/users/{user_id}/dependants \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "created_at": "<string>",
      "date_of_birth": "2000-01-15",
      "first_name": "<string>",
      "gender": "male",
      "id": "<string>",
      "last_modified_at": "<string>",
      "last_name": "<string>",
      "primary_user_id": "<string>",
      "relationship": "self",
      "salutation": "mr",
      "status": "active",
      "previous_version_id": "<string>"
    }
  ],
  "limit": 123,
  "offset": 123,
  "total": 123
}

Authorizations

Authorization
string
header
required

JWT access token. Obtain from /auth/otp/verify endpoint.

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
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