Query parameters
-
Filter by a comma separated list of UUIDs.
-
Filter by a comma separated list of account UUIDs.
-
Filter by a comma separated list of group UUIDs.
-
Filter by the circle name.
-
Comma separated list of relationships to include in the response. Valid relationships are [accounts,firm,groups]
-
Field to sort by. Valid fields are [name, created_at, updated_at]. Negative sign to denote DESC. Defaults to 'name'.
-
Number of results to return with pagination (Default 15. Max 500).
GET
/api/v1/circles
curl \
--request GET 'https://api.plannrcrm.com/api/v1/circles' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"data": [
{
"name": "Jones Family",
"uuid": "5a23c55a-28f8-41a8-a379-80792ed9ec31",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "73a3ec62-f6fc-48e5-a269-ac12ef3da3c4",
"created_at": "2025-09-26T13:23:31+01:00",
"updated_at": "2025-09-26T13:23:31+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "5d923477-3764-4a33-b7ac-e1be28c2b9c6",
"description": "UUID of the account"
},
"email": {
"example": "gareth@codepotato.co.uk",
"description": "Email of the account"
},
"last_name": {
"example": "Thompson",
"description": "Last name of the account"
},
"first_name": {
"example": "Gareth",
"description": "First name of the account"
}
},
"participants_count": "3"
}
],
"accounts": [
{
"name": "Gareth Thompson",
"role": "client",
"type": "client",
"uuid": "3b4da8af-8a03-49b6-bcb0-6fc8ac5388f0",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-09-26T13:23:31+01:00",
"first_name": "Gareth",
"updated_at": "2025-09-26T13:23:31+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"bg_colour": "#35f4e1",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"created_at": "2025-09-26T13:23:31+01:00",
"updated_at": "2025-09-26T13:23:31+01:00",
"joint_account_uuid": "23931cd9-a6ca-4ece-a500-f9ae052d3a95",
"login_access_level": "write",
"external_references": [
{
"uuid": "92b4ff3a-d9f6-4382-9bb3-ac6051315518",
"reference": "AB123456",
"created_at": "2025-09-26T13:23:31+01:00",
"updated_at": "2025-09-26T13:23:31+01:00",
"third_party": "nucleus"
}
]
}
]
}