GET
/
users
/
{user_id}
/
dependants
cURL
curl --request GET \
  --url http://localhost:8080/users/{user_id}/dependants
{
  "data": [
    {
      "created_at": "<string>",
      "date_of_birth": "2000-01-15",
      "first_name": "<string>",
      "id": "<string>",
      "last_modified_at": "<string>",
      "last_name": "<string>",
      "previous_version_id": "<string>",
      "primary_user_id": "012345678901"
    }
  ],
  "limit": 123,
  "offset": 123,
  "total": 123
}

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