Get all dependants

GET /api/v1/client/{client_uuid}/dependant

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

client_uuid string Required

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
- data array[object]
  
  Hide data attributes Show data attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  first_name string
  
  last_name string
  
  name string
  
  known_as string
  
  relationship string
  
  date_of_birth string
  
  is_financially_dependant boolean
  
  notes string
  
  accounts object
  
  Hide accounts attributes Show accounts attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  external_references string
  
  shared_owner_type string
  
  shared_owner object
  
  Hide shared_owner attributes Show shared_owner attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  ownership_percentage integer
  
  inactive_at string
  
  custom_fields string
  
  external_references string

GET /api/v1/client/{client_uuid}/dependant

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/client/6ff8f7f6-1eb3-3525-be4a-3932c805afed/dependant' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "data": [
    {
      "name": "Christopher Nolan",
      "uuid": "72cf827c-0fcf-4c42-ae31-7826a8db424b",
      "notes": "Example notes",
      "accounts": {
        "name": "Gareth Thompson",
        "role": "client",
        "type": "client",
        "uuid": "8202029f-e358-461a-9644-7739341286d5",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-06-25T15:10:42+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-06-25T15:10:42+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "known_as": "Chris",
      "last_name": "Nolan",
      "created_at": "2025-06-25T15:10:42+01:00",
      "first_name": "Christopher",
      "updated_at": "2025-06-25T15:10:42+01:00",
      "relationship": "Brother",
      "shared_owner": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "88693ba4-7333-4460-b838-cd4683772057",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-06-25T15:10:42+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-06-25T15:10:42+01:00",
        "with_login": true,
        "inactive_at": "2025-06-25",
        "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-06-25T15:10:42+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-06-25T15:10:42+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-06-25T15:10:42+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-06-25T15:10:42+01:00"
      },
      "date_of_birth": "2013-06-25T15:10:42+01:00",
      "shared_owner_type": "individual",
      "is_financially_dependant": true
    }
  ]
}