Get all dependants Run in API Explorer
Ask AI
Query parameters
-
Filter by a comma separated list of UUIDs.
-
Filter by a comma separated list of UUIDs.
-
Filter by a comma separated list of UUIDs.
-
Comma separated list of relationships to include in the response. Valid relationships are [accounts].
-
Field to sort by. Valid fields are [created_at, updated_at, first_name, last_name]. Negative sign to denote DESC. Defaults to 'created_at'.
-
Number of results to return with pagination (Default 15. Max 500).
GET
/api/v2/dependants
curl \
--request GET 'https://api.plannrcrm.com/api/v2/dependants' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"data": [
{
"uuid": "868b9b36-12b7-48ea-a251-1c38610b98c2",
"created_at": "2026-08-07T15:29:26+01:00",
"updated_at": "2026-08-07T15:29:26+01:00",
"first_name": "Christopher",
"last_name": "Nolan",
"name": "Christopher Nolan",
"known_as": "Chris",
"relationship": "Brother",
"date_of_birth": "1986-08-07T15:29:26+01:00",
"is_financially_dependant": true,
"notes": "Example notes",
"accounts": {
"uuid": "6412ea3c-8de2-432f-b775-5d0c6ad73704",
"created_at": "2026-08-07T15:29:26+01:00",
"updated_at": "2026-08-07T15:29:26+01:00",
"type": "client",
"role": "client",
"first_name": "Gareth",
"last_name": "Thompson",
"name": "Gareth Thompson",
"email": "gareth@codepotato.co.uk",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"external_references": {
"uuid": "2244294c-23fd-429a-b952-64a6fc469ad4",
"created_at": "2026-08-07T15:29:31+01:00",
"updated_at": "2026-08-07T15:29:31+01:00",
"third_party": "nucleus",
"reference": "AB123456"
}
}
}
]
}