Zum Inhalt springen
Docs
Deutsch
Esc
↑↓navigieren↵öffnen⌘Jvorschau

List cohort members

Returns a cursor-paginated list of cohort members. Each item includes membership fields and a nested user (id, name, email, image). Enrollment fields (statusId, legalEnrollmentEffectiveAt, matriculationNumber, technicalEnrollmentProcessedAt) may be null. Scoped to your integration’s institution via Basic Auth credentials.

GET/study-programs/{id}/cohorts/{cohortId}/members
Authorization
AuthorizationBasic auth · headerrequired

Basic Auth with clientId as username and clientSecret as password

Path parameters
idstringrequired
cohortIdstringrequired
Query parameters
cursorstring
limitinteger
default: 10
Responses
200

List of cohort members

dataCohortMembership[]required
Show properties
Array of CohortMembership
idstringrequired
userIdstringrequired
cohortIdstringrequired
institutionIdstringrequired
statusIdstring | nullrequired
createdAtstring<date-time> | nullrequired
updatedAtstring<date-time> | nullrequired
legalEnrollmentEffectiveAtstring<date-time> | nullrequired
matriculationNumberstring | nullrequired
technicalEnrollmentProcessedAtstring<date-time> | nullrequired
userSimpleUserrequired

Basic user reference (id, name, email, image).

Show properties
idstringrequired
namestringrequired
emailstring<email>required
imagestring | nullrequired
paginationCursorPaginationrequired
Show properties
next_cursorstring | nullrequired
has_morebooleanrequired
limitintegerrequired
metaResponseMetarequired
Show properties
requestIdstringrequired
timestampstring<date-time>required
versionstringrequired
Allowed:v4
401

Unauthorized

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
404

Not Found

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
429

Too Many Requests

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
500

Internal Server Error

typestringrequired
Allowed:error
codestringrequired
Allowed:bad_requestunauthorizedforbiddenresource_not_foundconflictvalidation_failedidempotency_key_reusedrate_limit_exceededinternal_error
titlestringrequired
statusintegerrequired
detailstringrequired
instancestring
errorsobject[]
Show properties
Array of object
fieldstring
messagestring
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://fuxam.app/api/v4/study-programs/string/cohorts/string/members' \
  -H 'Authorization: Basic YOUR_CREDENTIALS'
Response
{
  "data": [
    {
      "id": "cmem_001",
      "userId": "user_abc123",
      "cohortId": "coh_001",
      "institutionId": "inst_123",
      "statusId": null,
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": null,
      "legalEnrollmentEffectiveAt": null,
      "matriculationNumber": null,
      "technicalEnrollmentProcessedAt": null,
      "user": {
        "id": "user_abc123",
        "name": "Jane Doe",
        "email": "jane@example.com",
        "image": null
      }
    }
  ],
  "pagination": {
    "next_cursor": null,
    "has_more": false,
    "limit": 10
  },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2026-06-26T00:00:00.000Z",
    "version": "v4"
  }
}