Trainees

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

get/api/public/trainees

Query parameters

pagestring

Page number (1-based, default 1)

limitstring

Items per page (1-500, default 25)

searchstring

Search by name, email, or phone

labelIdstring

Filter to trainees with this label

emailstring

Match by email (case insensitive)

phonestring

Match by phone number

status'active' | 'inactive' | 'pending' | 'archived'

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.

Response

Successful response

Changes

No recorded changes to this endpoint across all 1 revision of this API.