Cohort
/api/v1/learning/cohortsA group of learners in a program.
listgetcreateupdateSchema
| Field | Type | Notes |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present. |
| created_at* | date-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| group_id | string | Underlying Group with kind=cohort. Format: grp-<uuid>. |
| program_id | string | Programme catalogue identifier. |
| name | string | Human-readable cohort name. |
| start_date | date-time | Programme start date (ISO 8601). |
| end_date | date-time | Programme end date (ISO 8601). |
| status | string | Lifecycle status of the cohort. |
| session_count | number | Total number of sessions in the programme. |
| facilitator_ids | json | User IDs of facilitators responsible for this cohort. |
| assigned_assessment_ids | json | Assessment IDs assigned to this cohort. Format: asm-<uuid>. |
| completion_required_pct | number | Minimum completion percentage required to pass the programme. |
| current_completion_pct | number | Computed current completion percentage across enrolled learners. |
| metadata | json | Arbitrary key-value metadata for app-specific extensions. |
| tags | json | Free-form tags for filtering and categorisation. |
| version | number | Optimistic concurrency version counter. |
API
client.learning.cohorts.*Loading manifest…