List live attendance

GET /api/v1/live-sessions/{liveSessionId}/attendance

Returns the enrollments of the cohort a live session targets, each with its current attendance. An enrollment with nothing recorded is listed with status unknown: this is the sheet to fill, not only what has been filled.

Authorization

Organization role

Role in the organization	This endpoint
`OWNER`	Allowed
`ADMIN`	Allowed
`MEMBER`	Refused — `403`

Business authorization

Requirement	Rule for this endpoint
Business role	None
Resource scope	Live session of the key's organization
Participation	None
Resource state	None — a live session that targets no cohort lists nobody

Path parameters

Parameter	Type	Required	Description
`liveSessionId`	UUID	yes	Live session of the key's organization

Request headers

Header	Required	Description
`x-api-key`	yes	API key created for this organization
`X-Correlation-Id`	no	Caller correlation id, returned or generated

Example

bash

curl "$COHORTE_API_BASE_URL/api/v1/live-sessions/$LIVE_SESSION_ID/attendance" \
  -H "x-api-key: $COHORTE_API_KEY"

Response

200 OK — the targeted enrollments, possibly an empty list.
401 Unauthorized — missing, unknown or expired key; code is unauthorized.
403 Forbidden — the bearer is not OWNER or ADMIN; code is forbidden.

Response fields

Field	Type	Nullable	Description
`success`	boolean	no	`true` for a successful request
`data[].enrollmentId`	UUID	no	Enrollment in the targeted cohort
`data[].memberName`	string	no	First and last name of the enrolled person
`data[].status`	string	no	`attended`, `absent`, `excused`, or `unknown` when nothing is recorded
`data[].reason`	string	yes	Reason recorded with the current value
`correlationId`	UUID	no	Correlation id for support

Example response

json

{
  "success": true,
  "data": [
    {
      "enrollmentId": "4af4cd8d-0000-4000-8000-000000000000",
      "memberName": "Amélie Martin",
      "status": "absent",
      "reason": "No show"
    },
    {
      "enrollmentId": "91c0e2f7-0000-4000-8000-000000000000",
      "memberName": "Karim Benali",
      "status": "unknown",
      "reason": null
    }
  ],
  "correlationId": "5f3b1a88-0000-4000-8000-000000000000"
}

Notes

An unknown live session answers an empty list, not 404 — as does a live session of another organization or one that targets no cohort. The response never reveals whether the id exists.
The organization is derived from the key and is never a query parameter.

GET /api/v1/live-sessions/{liveSessionId}/attendance

Authorization

Organization role

Role in the organization	This endpoint
`OWNER`	Allowed
`ADMIN`	Allowed
`MEMBER`	Refused — `403`

Business authorization

Requirement	Rule for this endpoint
Business role	None
Resource scope	Live session of the key's organization
Participation	None
Resource state	None — a live session that targets no cohort lists nobody

Path parameters

Parameter	Type	Required	Description
`liveSessionId`	UUID	yes	Live session of the key's organization

Request headers

Header	Required	Description
`x-api-key`	yes	API key created for this organization
`X-Correlation-Id`	no	Caller correlation id, returned or generated

Example

bash

curl "$COHORTE_API_BASE_URL/api/v1/live-sessions/$LIVE_SESSION_ID/attendance" \
  -H "x-api-key: $COHORTE_API_KEY"

Response

200 OK — the targeted enrollments, possibly an empty list.
401 Unauthorized — missing, unknown or expired key; code is unauthorized.
403 Forbidden — the bearer is not OWNER or ADMIN; code is forbidden.

Response fields

Field	Type	Nullable	Description
`success`	boolean	no	`true` for a successful request
`data[].enrollmentId`	UUID	no	Enrollment in the targeted cohort
`data[].memberName`	string	no	First and last name of the enrolled person
`data[].status`	string	no	`attended`, `absent`, `excused`, or `unknown` when nothing is recorded
`data[].reason`	string	yes	Reason recorded with the current value
`correlationId`	UUID	no	Correlation id for support

Example response

json

{
  "success": true,
  "data": [
    {
      "enrollmentId": "4af4cd8d-0000-4000-8000-000000000000",
      "memberName": "Amélie Martin",
      "status": "absent",
      "reason": "No show"
    },
    {
      "enrollmentId": "91c0e2f7-0000-4000-8000-000000000000",
      "memberName": "Karim Benali",
      "status": "unknown",
      "reason": null
    }
  ],
  "correlationId": "5f3b1a88-0000-4000-8000-000000000000"
}

Notes

An unknown live session answers an empty list, not 404 — as does a live session of another organization or one that targets no cohort. The response never reveals whether the id exists.
The organization is derived from the key and is never a query parameter.

List live attendance

List live attendance

Authorization

Organization role

Business authorization

Path parameters

Request headers

Example

Response

Response fields

Example response

Notes

Related

Authorization

Organization role

Business authorization

Path parameters

Request headers

Example

Response

Response fields

Example response

Notes

Related