Get all Accounts for the Circle
Gets a list of accounts for the circle with related data
Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Path parameters
-
circle_uuid
integer 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'.
GET
/api/v1/circles/{circle_uuid}/accounts
curl \
--request GET 'https://api.plannrcrm.com/api/v1/circles/circle_uuid/accounts' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"data": [
{
"name": "Gareth Thompson",
"uuid": "bdbfd59e-8247-4f13-8840-7bd40c93cdc2",
"email": "gareth@codepotato.co.uk",
"logins": [
{
"firm": "App\\Http\\Resources\\FirmResource",
"uuid": "80466eb3-b5d7-4514-be5b-f378fc9cd2de",
"email": "gareth@plannrcrm.com",
"account": "App\\Http\\Resources\\AccountResource",
"primary": false,
"last_name": "Thompson",
"created_at": "2025-05-22T11:40:35+01:00",
"expires_at": "2025-08-30T11:40:35+01:00",
"first_name": "Gareth",
"updated_at": "2025-05-22T11:40:35+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-05-22T11:40:35+01:00",
"updated_at": "2025-05-22T11:40:35+01:00",
"linked_clients": [
{
"name": "Gareth",
"uuid": "bad0d3fe-b6b5-4bd6-8ef4-11bda55c8f3e",
"relationship": "Father"
}
]
}
]
}