Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Path parameters
-
uuid
integer Required
GET
/api/v1/circles/{uuid}
curl \
--request GET 'https://api.plannrcrm.com/api/v1/circles/uuid' \
--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)
{
"name": "Jones Family",
"uuid": "c5cce631-2f0c-4486-be56-1e886064e0a1",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "f1db9222-7807-42fc-8392-1365d0ec3efd",
"created_at": "2025-04-22T13:44:16+01:00",
"updated_at": "2025-04-22T13:44:16+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "73c84f3f-7d8f-477c-8417-a84a8ab38ce6",
"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": "d78b60a3-ac76-4691-b7c6-cf8ed8989034",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-04-22T13:44:16+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-22T13:44:16+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"created_at": "2025-04-22T13:44:16+01:00",
"updated_at": "2025-04-22T13:44:16+01:00",
"joint_account_uuid": "11c91eb9-78d3-44ee-a6c9-d25e49c025bf"
}