Skip to content
RetorioRetorio API Docs

List a cohort’s assigned programs

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

Lists the programs assigned to this cohort, with each assignment’s window, status and per-scenario publish counts, ordered the way the admin app shows them.

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
Array<object>
object
createdAt
required
string format: date-time
extId
required
string
<= 64 characters
startDate
required
string format: date-time
endDate
required
string format: date-time
nullable
order
required
integer
programId
required

The assigned program’s ext id.

string
title
required

The assigned program’s title.

string
scenarioStatusCounts
required
object
unpublished
required
integer
publishing
required
integer
published
required
integer
cohortProgramStatus
required

upcoming before startDate, finished once endDate has passed (never for an open-ended assignment, which has no endDate), active otherwise.

string
Allowed values: upcoming active finished

Example 

[
  {
    "cohortProgramStatus": "upcoming"
  }
]

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.