Skip to content
RetorioRetorio API Docs

List an email cohort’s invite status

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

The cohort’s email participants with their full invite lifecycle (INVITED, ACTIVATED, DISABLED, REMOVED) rather than the bare participant row participants above returns. One row per user, from their most recent membership in this cohort. Meant for email cohorts: a token cohort is not refused, and lists its token users the same way.

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

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.