Get all dependants

GET /api/v2/dependants

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]

      Additional properties are allowed.
GET /api/v2/dependants 
curl \
 -X GET https://api.plannrcrm.com/api/v2/dependants \
 -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": "47e5a549-e12f-4532-8d5a-7dfdc22ab0fb",
      "notes": "Example notes",
      "accounts": {
        "name": "Gareth Thompson",
        "role": "client",
        "type": "client",
        "uuid": "17a83491-1c91-45f1-8fe2-da63e80a68ba",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-01-17T11:18:33+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-01-17T11:18:33+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "known_as": "Chris",
      "last_name": "Nolan",
      "created_at": "2025-01-17T11:18:33+00:00",
      "first_name": "Christopher",
      "updated_at": "2025-01-17T11:18:33+00:00",
      "relationship": "Brother",
      "date_of_birth": "1985-01-17T11:18:33+00:00",
      "is_financially_dependant": true
    }
  ]
}