Get all Accounts for the Circle

GET /api/v1/circles/{circle_uuid}/accounts

Personal access token & O auth2

Gets a list of accounts for the circle with related data

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

circle_uuid string Required

Query parameters

filter[account_uuids] string

Filter by a comma separated list of account UUIDs.
sort string

Field to sort by. Valid fields are [created_at, updated_at, name, email]. Negative sign to denote DESC. Defaults to 'name'.

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
  
  name string
  
  email string
  
  linked_clients array[object]
  
  Hide linked_clients attributes Show linked_clients attributes object
  
  uuid string
  
  name string
  
  relationship string
  
  logins array[object]
  
  Hide logins attributes Show logins attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  expires_at string
  
  has_write_permission boolean
  
  has_delete_permission boolean
  
  primary boolean
  
  receives_unread_notifications_email boolean
  
  wealth_enabled boolean
  
  goals_enabled boolean
  
  factfind_enabled boolean
  
  tasks_enabled boolean
  
  welcome_enabled boolean
  
  first_name string
  
  last_name string
  
  email string
  
  account string
  
  firm string
  
  is_impersonated boolean

GET /api/v1/circles/{circle_uuid}/accounts

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

Response examples (200)

{
  "data": [
    {
      "name": "Gareth Thompson",
      "uuid": "16d44a99-584c-4ef0-98a0-720f8d8b2a53",
      "email": "gareth@codepotato.co.uk",
      "logins": [
        {
          "firm": "App\\Http\\Resources\\FirmResource",
          "uuid": "9f1761b9-c172-4c78-8e1e-e298d29a709d",
          "email": "gareth@plannrcrm.com",
          "account": "App\\Http\\Resources\\AccountResource",
          "primary": false,
          "last_name": "Thompson",
          "created_at": "2025-06-26T11:37:02+01:00",
          "expires_at": "2025-10-04T11:37:02+01:00",
          "first_name": "Gareth",
          "updated_at": "2025-06-26T11:37:02+01:00",
          "goals_enabled": true,
          "tasks_enabled": true,
          "wealth_enabled": true,
          "is_impersonated": false,
          "welcome_enabled": true,
          "factfind_enabled": true,
          "has_write_permission": false,
          "has_delete_permission": false,
          "receives_unread_notifications_email": true
        }
      ],
      "created_at": "2025-06-26T11:37:02+01:00",
      "updated_at": "2025-06-26T11:37:02+01:00",
      "linked_clients": [
        {
          "name": "Gareth",
          "uuid": "0825e661-6694-4952-826f-6f8949f44b36",
          "relationship": "Father"
        }
      ]
    }
  ]
}