Get a circle

GET /api/v1/circles/{uuid}

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

uuid string Required

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- name string
  
  The Circle name
- photo_url string
  
  URL for initial avatar image
- bg_colour string
  
  Hex colour background for avatar
- accounts array[object]
  
  Accounts belonging to the circle
  
  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]
  
  Groups the circle belongs to
  
  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
  
  uuid of joint account where circle created from joint account
- login_access_level string
  
  The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write
- external_references array[object]
  
  The external references that have been added to the client.
  
  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/{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": "46d5bb39-1abc-4833-aa3d-61427c076efa",
  "groups": [
    {
      "name": "finance",
      "slug": "finance",
      "uuid": "e5b786eb-6437-465c-8298-4966d86fbd54",
      "created_at": "2025-09-17T15:46:51+01:00",
      "updated_at": "2025-09-17T15:46:51+01:00",
      "participants": {
        "name": {
          "example": "Gareth Thompson",
          "description": "Name of the account"
        },
        "role": {
          "example": "client",
          "description": "Role of the account"
        },
        "uuid": {
          "example": "f2443f2c-bce9-4458-aaa5-77a7a551b52c",
          "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": "fa92aa33-5a32-4e2d-b5e6-f5fa76d3b23c",
      "email": "gareth@codepotato.co.uk",
      "last_name": "Thompson",
      "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
      "created_at": "2025-09-17T15:46:51+01:00",
      "first_name": "Gareth",
      "updated_at": "2025-09-17T15:46:51+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-17T15:46:51+01:00",
  "updated_at": "2025-09-17T15:46:51+01:00",
  "joint_account_uuid": "d8298ab8-58a0-41c4-ad52-c48ee90bbab9",
  "login_access_level": "write",
  "external_references": [
    {
      "uuid": "57162cfb-036f-477d-977c-a977834ee521",
      "reference": "AB123456",
      "created_at": "2025-09-17T15:46:51+01:00",
      "updated_at": "2025-09-17T15:46:51+01:00",
      "third_party": "nucleus"
    }
  ]
}