GET
/api/v1/circles/{uuid}
curl \
--request GET 'https://api.plannrcrm.com/api/v1/circles/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"name": "Jones Family",
"uuid": "4fd74ff3-ca13-4d38-83cb-555a952d80bc",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "a754f27b-8ce8-4478-a2bd-0a6fe1a5d4c6",
"created_at": "2025-08-27T17:31:25+01:00",
"updated_at": "2025-08-27T17:31:25+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "9503236c-67fc-45e4-bb8e-6f3da1193e59",
"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": "91374c1c-7f14-4b68-8559-7fd82cf34001",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-08-27T17:31:25+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-27T17:31:25+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-08-27T17:31:25+01:00",
"updated_at": "2025-08-27T17:31:25+01:00",
"joint_account_uuid": "a712c02e-861c-4967-8fb7-d3ca61963e3c",
"login_access_level": "write",
"external_references": [
{
"uuid": "2f38da77-11c6-4f9e-bde6-38fd33c476dd",
"reference": "AB123456",
"created_at": "2025-08-27T17:31:25+01:00",
"updated_at": "2025-08-27T17:31:25+01:00",
"third_party": "nucleus"
}
]
}