Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Query parameters
-
filter[uuid]
string Filter by a comma separated list of UUIDs.
-
filter[account_uuids]
string Filter by a comma separated list of UUIDs.
-
filter[circle_uuids]
string Filter by a comma separated list of UUIDs.
-
include
string Comma separated list of relationships to include in the response. Valid relationships are [accounts].
-
sort
string Field to sort by. Valid fields are [created_at, updated_at, first_name, last_name]. Negative sign to denote DESC. Defaults to 'created_at'.
-
per_page
integer 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 {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"data": [
{
"name": "Christopher Nolan",
"uuid": "a46da1c1-3c0e-4597-8aea-8453d11781c7",
"notes": "Example notes",
"accounts": {
"name": "Gareth Thompson",
"role": "client",
"type": "client",
"uuid": "408e8a97-3c52-40d5-9cb1-666a22f568df",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-04-03T14:12:22+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-03T14:12:22+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"known_as": "Chris",
"last_name": "Nolan",
"created_at": "2025-04-03T14:12:22+01:00",
"first_name": "Christopher",
"updated_at": "2025-04-03T14:12:22+01:00",
"relationship": "Brother",
"date_of_birth": "1985-04-03T14:12:22+01:00",
"is_financially_dependant": true
}
]
}