/api/v1/training/trainees
Retrieve and search trainees.
Permission | Description |
---|---|
trainees.view | View your own trainers and trainees |
trainees.view_any | View all trainee records in the system (admin only) |
Name | Type | Required | Description |
---|---|---|---|
user_id | string | No | Filter by trainee user IDs (comma-separated for multiple) |
trainer_id | string | No | Filter by trainer user IDs (comma-separated for multiple) |
training_service_id | string | No | Filter by training service IDs (comma-separated for multiple) |
is_delivered | boolean | No | Filter by delivery status |
page | int | No | Page number for pagination |
sort | string | No | asc for oldest, desc for latest (default: desc ) |
{
"data": [<trainee resource>, ...],
"links": {<pagination data>},
"meta": {<pagination data>}
}
Status | Error Type | Reference |
---|---|---|
401 | Unauthorized | Authentication error |
403 | Forbidden | Permission error |
404 | Not Found | Not-found error |