Get all circles

GET /api/v1/circles

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]

      Additional properties are allowed.
GET /api/v1/circles 
curl \
 -X GET https://api.plannrcrm.com/api/v1/circles \
 -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) 
{
  "data": [
    {
      "name": "Jones Family",
      "uuid": "d8c6def4-73ec-44f5-872f-9d891ef90671",
      "groups": [
        {
          "name": "finance",
          "slug": "finance",
          "uuid": "29705011-77e4-4554-a32c-7788c86add00",
          "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": "5e08fcf5-640d-491a-ac03-79f2e4238335",
              "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": "409a8c1f-20de-4361-a1d6-c57e346a459d",
          "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"
    }
  ]
}