Skip to content

List all email participants

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

Every cohort membership of the email-invited users across the whole organization, not scoped to one cohort: one row per user and cohort, removed memberships included (state: REMOVED). Useful for mapping users from your HR system by email address without knowing each person’s cohort ahead of time.

Auth
Access key
Roles
Owner / Admin / Custom

OK

Media typeapplication/json
Array<object>
object
createdAt
required
string format: date-time
profile

The user’s stored profile, or null when none is stored.

object
key
additional properties
nullable
email
required
string
<= 255 characters
lastInvitedAt
required
string format: date-time
nullable
isDisabled
required
boolean
userId
required

The user’s ext id.

string
cohortExtId
required

The cohort of this membership, null once that cohort is deleted.

string
nullable
cohortName
required

The cohort name, null once that cohort is deleted.

string
nullable
state
required

REMOVED when this membership was removed, otherwise DISABLED for a disabled user, ACTIVATED once the user has signed up, and INVITED before that.

string
Allowed values: ACTIVATED INVITED DISABLED REMOVED
participantId
required

The membership’s ext id.

string

Example

[
{
"state": "ACTIVATED"
}
]

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"
}

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 coaching-users: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"
}

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.