Get all dependants

GET /api/v1/client/{client_uuid}/dependant
Personal access token & O auth2

Query parameters

  • include string

    Comma separated list of relationships to include in the response. Valid relationships are [accounts, 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).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
GET /api/v1/client/{client_uuid}/dependant 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/client/client_uuid/dependant' \
 --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": "13914f25-4ba6-4150-b09b-b51651b76150",
      "notes": "Example notes",
      "accounts": {
        "name": "Gareth Thompson",
        "role": "client",
        "type": "client",
        "uuid": "83deb74e-59fc-4fc9-b495-0c05fa67bc66",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-04-02T13:27:55+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-04-02T13:27:55+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "known_as": "Chris",
      "last_name": "Nolan",
      "created_at": "2025-04-02T13:27:55+01:00",
      "first_name": "Christopher",
      "updated_at": "2025-04-02T13:27:55+01:00",
      "relationship": "Brother",
      "shared_owner": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "c0517429-f764-480e-979c-fc2e94faac21",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-04-02T13:27:55+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-04-02T13:27:55+01:00",
        "with_login": true,
        "inactive_at": "2025-04-02",
        "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": "2025-04-02T13:27:55+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-04-02T13:27:55+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "joint_account_circle": "App\\Http\\Resources\\CircleResource",
        "ownership_percentage": 100,
        "previous_review_date": "2025-04-02T13:27:55+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-04-02T13:27:55+01:00"
      },
      "date_of_birth": "2013-04-02T13:27:55+01:00",
      "shared_owner_type": "individual",
      "is_financially_dependant": true
    }
  ]
}