Get all Accounts for the Circle

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

Gets a list of accounts for the circle with related data

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]

      Additional properties are allowed.
GET /api/v1/circles/{circle_uuid}/accounts 
curl \
 -X GET https://api.plannrcrm.com/api/v1/circles/circle_uuid/accounts \
 -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": "Gareth Thompson",
      "uuid": "2131af7f-0bbd-4ff1-9a31-14dfa033d728",
      "email": "gareth@codepotato.co.uk",
      "logins": [
        {
          "firm": "App\\Http\\Resources\\FirmResource",
          "uuid": "b1c224dd-5026-4692-acea-8a637fd494b2",
          "email": "gareth@plannrcrm.com",
          "account": "App\\Http\\Resources\\AccountResource",
          "primary": false,
          "last_name": "Thompson",
          "created_at": "2025-01-29T10:30:12+00:00",
          "expires_at": "2025-05-09T10:30:12+01:00",
          "first_name": "Gareth",
          "updated_at": "2025-01-29T10:30:12+00: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-01-29T10:30:12+00:00",
      "updated_at": "2025-01-29T10:30:12+00:00",
      "linked_clients": [
        {
          "name": "Gareth",
          "uuid": "5a4d0946-692f-40f4-aed6-d7261ea32d1e",
          "relationship": "Father"
        }
      ]
    }
  ]
}