Get all linked clients for clients of a circle

GET /api/v1/circles/{circle_uuid}/linked-clients

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": "05b36bdd-03b8-4d63-a05b-52dffeb744f9",
      "email": "gareth@codepotato.co.uk",
      "created_at": "2025-09-17T15:46:51+01:00",
      "updated_at": "2025-09-17T15:46:51+01:00",
      "linked_clients": [
        {
          "name": "Gareth",
          "uuid": "f4bc0a0f-742c-483d-bbe0-0e975f832b5f",
          "relationship": "Father"
        }
      ]
    }
  ]
}