Get all Accounts for the Circle Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
"PlannrCRM MCP server": {
  "url": "https://apidocs.plannrcrm.com/mcp"
}
Close
GET /api/v1/circles/{circle_uuid}/accounts

Gets a list of accounts for the circle with related data

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • circle_uuid string Required

Query parameters

  • filter[account_uuids] string

    Filter by a comma separated list of account UUIDs.

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, name, email]. Negative sign to denote DESC. Defaults to 'name'.

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
      • email string
      • linked_clients array[object]
        Hide linked_clients attributes Show linked_clients attributes object
        • uuid string
        • name string
        • relationship string
      • logins array[object]
        Hide logins attributes Show logins attributes object
        • uuid string
        • created_at string
        • updated_at string
        • expires_at string
        • has_write_permission boolean
        • has_delete_permission boolean
        • primary boolean
        • receives_unread_notifications_email boolean
        • wealth_enabled boolean
        • goals_enabled boolean
        • factfind_enabled boolean
        • tasks_enabled boolean
        • welcome_enabled boolean
        • first_name string
        • last_name string
        • email string
        • user_type string
        • account string
        • firm string
        • is_impersonated boolean
GET /api/v1/circles/{circle_uuid}/accounts
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/circles/6ff8f7f6-1eb3-3525-be4a-3932c805afed/accounts' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
  "data": [
    [
      {
        "uuid": "8ade5d2b-af0e-4c1b-938e-a1cf44df6763",
        "created_at": "2026-06-09T14:10:13+01:00",
        "updated_at": "2026-06-09T14:10:13+01:00",
        "name": "Gareth Thompson",
        "email": "gareth@codepotato.co.uk",
        "linked_clients": [
          {
            "uuid": "fc787c53-d3fc-4a8c-8b5b-313325027e9d",
            "name": "Gareth",
            "relationship": "Father"
          }
        ],
        "logins": [
          {
            "uuid": "d751afdd-a86d-4a89-bc09-9de6e96165ce",
            "created_at": "2026-06-09T14:10:13+01:00",
            "updated_at": "2026-06-09T14:10:13+01:00",
            "expires_at": "2026-09-17T14:10:13+01:00",
            "has_write_permission": false,
            "has_delete_permission": false,
            "primary": false,
            "receives_unread_notifications_email": true,
            "wealth_enabled": true,
            "goals_enabled": true,
            "factfind_enabled": true,
            "tasks_enabled": true,
            "welcome_enabled": true,
            "first_name": "Gareth",
            "last_name": "Thompson",
            "email": "gareth@plannrcrm.com",
            "user_type": "standard",
            "account": "App\\Http\\Resources\\AccountResource",
            "firm": "App\\Http\\Resources\\FirmResource",
            "is_impersonated": false
          }
        ]
      }
    ]
  ]
}