Get a circle

GET /api/v1/circles/{uuid}

Personal access token & OAuth2

Headers

Path parameters

uuid integer 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
- accounts array[object]
  
  Accounts belonging to the circle
  
  Additional properties are allowed.
- groups array[object]
  
  Groups the circle belongs to
  
  Additional properties are allowed.

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": "d0a6e335-6799-4f5a-aa1a-3837e5e8af32",
  "groups": [
    {
      "name": "finance",
      "slug": "finance",
      "uuid": "c2c38da1-7463-4bbe-961e-777e1a107d7f",
      "created_at": "2025-02-20T10:13:01+00:00",
      "updated_at": "2025-02-20T10:13:01+00:00",
      "participants": {
        "name": {
          "example": "Gareth Thompson",
          "description": "Name of the account"
        },
        "role": {
          "example": "client",
          "description": "Role of the account"
        },
        "uuid": {
          "example": "f5d826e4-f3bc-44e5-8da8-b3b0d47db37e",
          "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": "a5e79e9d-e70d-40e8-a709-cc1ad71e2ba9",
      "email": "gareth@codepotato.co.uk",
      "last_name": "Thompson",
      "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
      "created_at": "2025-02-20T10:13:01+00:00",
      "first_name": "Gareth",
      "updated_at": "2025-02-20T10:13:01+00:00",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
    }
  ],
  "created_at": "2025-02-20T10:13:01+00:00",
  "updated_at": "2025-02-20T10:13:01+00:00"
}