Get all dependants
Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Query parameters
-
include string
Comma separated list of relationships to include in the response. Valid relationships are [shared_owner].
-
filter[uuid] string
Filter by a comma separated list of UUIDs.
-
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/v1/client/{client_uuid}/dependant
curl \
-X GET https://api.plannrcrm.com/api/v1/client/client_uuid/dependant \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"data": [
{
"name": "Christopher Nolan",
"uuid": "cab10eb8-a2d2-4aca-af0f-1f2d4bd2c833",
"notes": "Example notes",
"known_as": "Chris",
"last_name": "Nolan",
"created_at": "2024-10-16T11:10:14+01:00",
"first_name": "Christopher",
"updated_at": "2024-10-16T11:10:14+01:00",
"relationship": "Brother",
"shared_owner": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "7f9b0cc0-7c1f-4bfd-8a07-055e59cf8f4f",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2024-10-16T11:10:14+01:00",
"first_name": "Gareth",
"updated_at": "2024-10-16T11:10:14+01:00",
"with_login": true,
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2024-10-16T11:10:14+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2024-10-16T11:10:14+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2024-10-16T11:10:14+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2024-10-16T11:10:14+01:00"
},
"date_of_birth": "1984-10-16T11:10:14+01:00",
"shared_owner_type": "individual",
"is_financially_dependant": true
}
]
}