List trainees (GET /api/public/trainees)

List trainees of the coach, filterable by label/search.

Authentication

Requires an API key, sent as Authorization: Bearer cp_live_....

API keys carry scopes. Get the catalog of scopes and webhook events lists every scope.

Query parameters

Query parameters
Name	Type	Description
`page`	`string`	Page number (1-based, default 1)
`limit`	`string`	Items per page (1-500, default 25)
`search`	`string`	Search by name, email, or phone
`labelId`	`string`	Filter to trainees with this label
`email`	`string`	Match by email (case insensitive)
`phone`	`string`	Match by phone number
`status`	`string`	Filter by coaching status. "active" = has an active coaching period. "pending" = invited but not yet approved by the coach; these trainees are not returned by the other filters, and their activeCoachDetails.pendingCoachDate tells you how long they have been waiting. "archived" = removed with `DELETE /trainees/{traineeId}`; they are excluded from every other filter and from `GET /trainees/{traineeId}`, which answers 403 for them, so this is the only way to see them. Archived results carry no activeCoachDetails, and support only page, limit, search, email and phone. Bring one back with `POST /trainees/{traineeId}/restore`. Allowed values: `active` `inactive` `pending` `archived`

Request examples

cURL

curl --request GET \
  --url 'https://api.coach-platform.com/api/public/trainees' \
  --header 'Authorization: Bearer cp_live_...'

JavaScript (fetch)

const response = await fetch('https://api.coach-platform.com/api/public/trainees', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer cp_live_...',
  },
});

const data = await response.json();

Responses

`200` OK

Successful response

Example body (application/json)

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "phoneNumber": "<string>",
      "goal": "<string>",
      "profileImageUrl": "<string>",
      "personalDetails": {},
      "labels": [
        {
          "id": "<string>",
          "text": "<string>",
          "color": "<string>",
          "coachId": "<string>"
        }
      ],
      "assignedEmployees": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "activeCoachDetails": {
        "activeEscort": "<string>",
        "pendingCoach": "<string>",
        "pendingCoachDate": "<date-time>"
      },
      "createdAt": "<date-time>"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "hasMore": true,
    "truncated": true
  }
}

Response fields (27)

Response fields
Name	Type	Description
`data`	`object[]`
`data[].id`	`string`
`data[].name`	`string`
`data[].email`	`string`
`data[].phoneNumber`	`string`
`data[].goal`	`string`
`data[].profileImageUrl`	`string`
`data[].personalDetails`	`object`
`data[].labels`	`object[]`
`data[].labels[].id`	`string`
`data[].labels[].text`	`string`
`data[].labels[].color`	`string`
`data[].labels[].coachId`	`string`
`data[].assignedEmployees`	`object[]`
`data[].assignedEmployees[].id`	`string`
`data[].assignedEmployees[].name`	`string`
`data[].activeCoachDetails`	`object`
`data[].activeCoachDetails.activeEscort`	`string \| null`	Id of the escort currently in use for this trainee. Fetch the full escort with `GET /escorts/{escortId}`.
`data[].activeCoachDetails.pendingCoach`	`string \| null`	Coach id this trainee is pending approval for. Set when the trainee was invited but has not been approved yet; null once approved. Use ?status=pending on `GET /trainees` to list only these.
`data[].activeCoachDetails.pendingCoachDate`	`string<date-time> \| null`	When the trainee entered the pending state. Use it to measure how long approval has been waiting.
`data[].createdAt`	`string<date-time>`
`pagination`	`object`
`pagination.page`	`number`
`pagination.limit`	`number`
`pagination.total`	`number \| null`	Total number of matching items. null when the underlying source cannot report an exact count for this page; use hasMore to keep paging.
`pagination.hasMore`	`boolean`
`pagination.truncated`	`boolean`	Present and true when the result set exceeded the in-memory scan cap and was truncated. Narrow your filters to page through all items.

Error responses

400 Bad Request
401 Unauthorized
403 Forbidden
429 Too Many Requests
500 Internal Server Error

These statuses share the same response body.

Example body (application/json)

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "fix": "<string>",
    "details": {},
    "retryAfterMs": 123
  }
}

Error fields (6)

Error fields
Name	Type	Description
`error`	`object`
`error.code`	`string`
`error.message`	`string`
`error.fix`	`string \| null`
`error.details`	`object \| null`
`error.retryAfterMs`	`number \| null`

This page is also available as Markdown. Browse it in the interactive explorer or download the OpenAPI spec.