Get a circle

GET /api/v1/circles/{uuid}

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 \
 -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": "b908bbad-cc8b-4eac-b11b-59b6da5b5fa7",
  "groups": [
    {
      "name": "finance",
      "slug": "finance",
      "uuid": "f1856698-a67c-49c0-9f6b-e51a0a42ffbb",
      "created_at": "2025-01-17T11:18:28+00:00",
      "updated_at": "2025-01-17T11:18:28+00:00",
      "participants": {
        "name": {
          "example": "Gareth Thompson",
          "description": "Name of the account"
        },
        "role": {
          "example": "client",
          "description": "Role of the account"
        },
        "uuid": {
          "example": "6533b3ee-a125-4937-bb76-a7c573e08967",
          "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": "4e1d0df5-4243-4edb-aa71-2af48d0acbee",
      "email": "gareth@codepotato.co.uk",
      "last_name": "Thompson",
      "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
      "created_at": "2025-01-17T11:18:28+00:00",
      "first_name": "Gareth",
      "updated_at": "2025-01-17T11:18:28+00:00",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
    }
  ],
  "created_at": "2025-01-17T11:18:28+00:00",
  "updated_at": "2025-01-17T11:18:28+00:00"
}