Get all dependants

GET /api/v2/dependants

Personal access token & O auth2

Headers

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).

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

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": [
    {
      "name": "Christopher Nolan",
      "uuid": "20cc89d6-d155-4caf-853d-67d9a54f7e81",
      "notes": "Example notes",
      "accounts": {
        "name": "Gareth Thompson",
        "role": "client",
        "type": "client",
        "uuid": "df30ec80-6eff-4bc5-ba19-b266bd87d022",
        "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:49+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-06-25T15:10:49+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "known_as": "Chris",
      "last_name": "Nolan",
      "created_at": "2025-06-25T15:10:49+01:00",
      "first_name": "Christopher",
      "updated_at": "2025-06-25T15:10:49+01:00",
      "relationship": "Brother",
      "date_of_birth": "1985-06-25T15:10:49+01:00",
      "is_financially_dependant": true
    }
  ]
}