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
      • 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
      • 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": "e82c3a38-5c29-42c7-abf2-6d50dbe79532",
      "groups": [
        {
          "name": "finance",
          "slug": "finance",
          "uuid": "947b60ee-040d-497e-978f-fc9f7cc29512",
          "created_at": "2025-07-17T16:23:18+01:00",
          "updated_at": "2025-07-17T16:23:18+01:00",
          "participants": {
            "name": {
              "example": "Gareth Thompson",
              "description": "Name of the account"
            },
            "role": {
              "example": "client",
              "description": "Role of the account"
            },
            "uuid": {
              "example": "7d2c109c-75ca-40e4-8ebe-70ad0277e79e",
              "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": "1c0dd078-8712-4069-a5f9-4551d2eca699",
          "email": "gareth@codepotato.co.uk",
          "last_name": "Thompson",
          "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
          "created_at": "2025-07-17T16:23:18+01:00",
          "first_name": "Gareth",
          "updated_at": "2025-07-17T16:23:18+01:00",
          "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
        }
      ],
      "created_at": "2025-07-17T16:23:18+01:00",
      "updated_at": "2025-07-17T16:23:18+01:00",
      "joint_account_uuid": "9952c0f4-8627-4878-a1a5-e19cd1f7d581",
      "external_references": [
        {
          "uuid": "8af527f6-b2e5-4237-a29d-2e8a981369b1",
          "reference": "AB123456",
          "created_at": "2025-07-17T16:23:18+01:00",
          "updated_at": "2025-07-17T16:23:18+01:00",
          "third_party": "nucleus"
        }
      ]
    }
  ]
}