Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Query parameters
-
filter[uuid]
string Filter by a comma separated list of UUIDs.
-
filter[account_uuids]
string Filter by a comma separated list of account UUIDs.
-
filter[group_uuids]
string Filter by a comma separated list of group UUIDs.
-
filter[name]
string Filter by the circle name.
-
include
string Comma separated list of relationships to include in the response. Valid relationships are [accounts,firm,groups]
-
sort
string Field to sort by. Valid fields are [name, created_at, updated_at]. Negative sign to denote DESC. Defaults to 'name'.
-
per_page
integer 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 {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": "Jones Family",
"uuid": "03623888-6c6a-416b-9f94-68a9f7a0c5bc",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "e6828858-f7d6-46c7-9871-06a5b1ec4152",
"created_at": "2025-04-02T13:27:54+01:00",
"updated_at": "2025-04-02T13:27:54+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "7020e2bf-bd74-4e08-b2b4-930ac6a7fe48",
"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": "8b640408-3a86-45fc-89d7-f06bea0b345e",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-04-02T13:27:54+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-02T13:27:54+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"created_at": "2025-04-02T13:27:54+01:00",
"updated_at": "2025-04-02T13:27:54+01:00",
"joint_account_uuid": "36218725-4a33-4fa1-a181-9ccc88eb5f76"
}
]
}