Skip to content
RetorioRetorio API Docs

Get a cohort

GET
/cohorts/{id}
curl --request GET \
  --url https://api.retorio.com/be/v2/cohorts/b2d7e4a1_55c3_4f28_9e10_7a3d6c4b8f02 \
  --header 'Authorization: Bearer <token>'

One cohort of your organization, by its ext id: its name, type, creation time, whether it is used for benchmarking, and how many participants it has.

Authentication

Section titled “Authentication”
Auth
Access key
Roles
Owner / Admin / Custom

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Example 

b2d7e4a1_55c3_4f28_9e10_7a3d6c4b8f02

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
extId
required
string
<= 64 characters
name
required
string
<= 255 characters
createdAt
required
string format: date-time
isForBenchmarking
required
boolean
type
required
string
Allowed values: email token
participants
required

Total participants in the cohort.

integer
activeTokens
required

Generated tokens already redeemed by a coaching user.

integer
availableTokens
required

Generated tokens not yet redeemed.

integer
programs

How many programs the cohort has assigned, whatever each assignment’s period (an upcoming or finished assignment counts, an unassigned one does not). Always present on GET /cohorts/{id}. On GET /cohorts it is present only with includeRecordingSessions=true.

integer
recordingSessions
required

Attempts with a result, not deleted, made through the cohort’s current program assignments. Only GET /cohorts?includeRecordingSessions=true computes it. It is 0 everywhere else, including GET /cohorts/{id}.

integer
activeEmails
required

Email-invited users who have completed registration.

integer

Example 

{
  "type": "email"
}

401

Section titled “401”

Not authenticated: the bearer token is missing, malformed, expired or revoked, its sign-in method does not match your organization’s configuration, the user it belongs to was removed, or your organization is deactivated.

Media typeapplication/json
object
message
required
string
status
required

Canonical error name, e.g. INVALID_ARGUMENT.

string
details
nullable

Example generated

{
  "message": "example",
  "status": "example",
  "details": "example"
}

403

Section titled “403”

Refused: the token does not belong to an admin, or your organization does not have the coaching product, or the admin’s roles do not grant cohorts:view.

Media typeapplication/json
Any of:
object
message
required
string
status
required

Canonical error name, e.g. INVALID_ARGUMENT.

string
details
nullable

Example generated

{
  "message": "example",
  "status": "example",
  "details": "example"
}

404

Section titled “404”

No cohort with this id in your organization.

Media typeapplication/json
object
message
required
string
status
required

Canonical error name, e.g. INVALID_ARGUMENT.

string
details
nullable

Example generated

{
  "message": "example",
  "status": "example",
  "details": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
key
additional properties
nullable

Example generated

{
  "additionalProperty": "example"
}

Retorio is GDPR and DSGVO compliant, EU AI Act aligned, ISO 27001 certified, and hosted on Google Cloud with EU data residency. For anything specific to your rollout, ask your Retorio contact.