Skip to content
AiKYNETIX

Fetch a client group

GET
/api/client-groups/{id}/
curl --request GET \
  --url http://localhost:8000/api/client-groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

A team-scoped client group (#545). name / description / colour are writable on create + PATCH; the roster (member_ids) is read-only here — mutate it via the /members/ endpoints. member_count powers the board column header without a second round-trip.

object
id
required
string format: uuid
name
required

Group name. Required; unique within the team.

string
<= 120 characters
description

Optional free-text description of the group.

string
<= 500 characters
colour

Optional UI tint — a design-token key (e.g. tone-recovery) or empty. Cosmetic; the board falls back to a deterministic colour.

string
<= 32 characters
member_ids
required

UUIDs of the clients in this group (many-to-many).

Array<string>
member_count
required

Number of clients in the group.

integer
has_ranges
required

Whether the group carries any target range of its own (#2518) — a MetricThreshold row with client_group = this group. Edit them in /api/thresholds/?client_group=<id>.

boolean
ranges_priority
required

Precedence of this group’s own target ranges (#2518) for a client in several groups: per metric, the group first in (ranges_priority, created_at, id) order wins — LOWER wins. Not unique (ties fall back to creation order). Read-only here; set it with POST /api/client-groups/ranges-priority/. A new group starts at the bottom.

integer
created_at
required
string format: date-time
updated_at
required
string format: date-time

Examples

ExampleSprintSquad

Sprint squad

{
  "id": "b3f1c0a2-0000-4000-8000-000000000001",
  "name": "Sprint squad",
  "description": "100–400 m specialists",
  "colour": "tone-recovery",
  "member_ids": [
    "a1f1c0a2-0000-4000-8000-0000000000aa"
  ],
  "member_count": 1,
  "has_ranges": true,
  "ranges_priority": 0,
  "created_at": "2026-06-10T12:00:00Z",
  "updated_at": "2026-06-10T12:00:00Z"
}

401

Section titled “401”
Media typeapplication/json
object
detail
required

Human-readable message, or a stable machine code for the cases a client branches on. The standard envelope for 400 (validation — a field-keyed object may appear instead), 401 (missing / invalid credentials), 403 (authenticated but not permitted), and 404 (absent — cross-team records are collapsed to 404 so the API never leaks the existence of another team’s data).

string

Example generated

{
  "detail": "example"
}

404

Section titled “404”
Media typeapplication/json
object
detail
required

Human-readable message, or a stable machine code for the cases a client branches on. The standard envelope for 400 (validation — a field-keyed object may appear instead), 401 (missing / invalid credentials), 403 (authenticated but not permitted), and 404 (absent — cross-team records are collapsed to 404 so the API never leaks the existence of another team’s data).

string

Example generated

{
  "detail": "example"
}