Get all circles

GET /api/v1/circles

Personal access token & O auth2

Headers

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).

Responses

200 application/json
Hide response attribute Show response attribute object
- data array[object]
  
  Hide data attributes Show data attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  photo_url string
  
  bg_colour string
  
  accounts array[object]
  
  Hide accounts attributes Show accounts attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  external_references string
  
  groups array[object]
  
  Hide groups attributes Show groups attributes object
  
  uuid string
  
  name string
  
  slug string
  
  participants_count string
  
  participants object
  
  Hide participants attributes Show participants attributes object
  
  uuid object
  
  Hide uuid attributes Show uuid attributes object
  
  example string
  
  description string
  
  role object
  
  Hide role attributes Show role attributes object
  
  example string
  
  description string
  
  first_name object
  
  Hide first_name attributes Show first_name attributes object
  
  example string
  
  description string
  
  last_name object
  
  Hide last_name attributes Show last_name attributes object
  
  example string
  
  description string
  
  name object
  
  Hide name attributes Show name attributes object
  
  example string
  
  description string
  
  email object
  
  Hide email attributes Show email attributes object
  
  example string
  
  description string
  
  created_at string
  
  updated_at string
  
  joint_account_uuid string
  
  login_access_level string
  
  external_references array[object]
  
  Hide external_references attributes Show external_references attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  third_party string
  
  reference string

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": "6eeca939-3acf-4bce-9ced-eb5093c68a54",
      "groups": [
        {
          "name": "finance",
          "slug": "finance",
          "uuid": "b7143874-9283-4dc9-9bf4-e4c80db642c9",
          "created_at": "2025-09-05T20:52:46+01:00",
          "updated_at": "2025-09-05T20:52:46+01:00",
          "participants": {
            "name": {
              "example": "Gareth Thompson",
              "description": "Name of the account"
            },
            "role": {
              "example": "client",
              "description": "Role of the account"
            },
            "uuid": {
              "example": "a127ec4b-f810-4de9-bae2-c28f52ce64fe",
              "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": "db552a1e-4472-4204-960c-3ad6f2f255a8",
          "email": "gareth@codepotato.co.uk",
          "last_name": "Thompson",
          "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
          "created_at": "2025-09-05T20:52:46+01:00",
          "first_name": "Gareth",
          "updated_at": "2025-09-05T20:52:46+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-05T20:52:46+01:00",
      "updated_at": "2025-09-05T20:52:46+01:00",
      "joint_account_uuid": "9acfcfb8-78fe-499d-80a0-24cfb2bdbd03",
      "login_access_level": "write",
      "external_references": [
        {
          "uuid": "77f3ff2d-166b-4969-865e-7c7734710459",
          "reference": "AB123456",
          "created_at": "2025-09-05T20:52:46+01:00",
          "updated_at": "2025-09-05T20:52:46+01:00",
          "third_party": "nucleus"
        }
      ]
    }
  ]
}