Get all linked clients for clients of a circle Run in API Explorer

GET /api/v1/circles/{circle_uuid}/linked-clients
Personal access token & O auth2

Path parameters

  • circle_uuid string Required

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
GET /api/v1/circles/{circle_uuid}/linked-clients 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/circles/6ff8f7f6-1eb3-3525-be4a-3932c805afed/linked-clients' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": [
    {
      "name": "Gareth Thompson",
      "uuid": "462a8c57-19b5-42f9-b3ea-c09bc99d4b85",
      "email": "gareth@codepotato.co.uk",
      "created_at": "2025-11-17T21:14:38+00:00",
      "updated_at": "2025-11-17T21:14:38+00:00",
      "linked_clients": [
        {
          "name": "Gareth",
          "uuid": "383a5f07-ffa6-496e-a105-1575cd60899c",
          "relationship": "Father"
        }
      ]
    }
  ]
}