Get a circle
Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
GET
/api/v1/circles/{uuid}
curl \
-X GET https://api.plannrcrm.com/api/v1/circles/uuid \
-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)
{
"name": "Jones Family",
"uuid": "4473b3f9-ff19-49f6-b797-fe1d3440c42e",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "c47921e4-5801-4cc7-b9b5-4a7fe66f6795",
"created_at": "2025-01-21T09:11:08+00:00",
"updated_at": "2025-01-21T09:11:08+00:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "777792b9-2293-40ca-a956-d54be7d8d308",
"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": "cc705d25-c5e9-4958-93f7-ea55ce9e95fc",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-01-21T09:11:08+00:00",
"first_name": "Gareth",
"updated_at": "2025-01-21T09:11:08+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"created_at": "2025-01-21T09:11:08+00:00",
"updated_at": "2025-01-21T09:11:08+00:00"
}