cac8702ed2aa
Get training campaigns
Get many training campaigns.
The query parameter filters are applied as AND conditions across different filters. If multiple filters are used, the response will include only the training campaigns that satisfy all the filters.
Within a single filter, multiple values are applied as OR conditions.
Query parameters
Use this parameter to filter training campaigns by id.
[ "tc456xyz78" ]
Filter training campaigns by status. When omitted, training campaigns of all statuses will be included in the response.
[ "ACTIVE" ]
Use this parameter to limit the number of entities returned.
Use this parameter to paginate through entities. The cursor is the id of the last entity you want to start from.
To get the first page, omit this parameter.
To get the next page, use the id of the last entity from the previous response. Continue paginating while hasMore is true in the response.
Example workflow:
- GET /v1/{endpoint} → returns data + hasMore: true, last entity id: "xyz789end"
- GET /v1/{endpoint}?cursor=xyz789end → returns next page
Response
Success
Example response
{
"data": [
{
"id": "tc456xyz78",
"courseName": "Cybersecurity Awareness",
"campaignName": "Security Training 2025",
"status": "ACTIVE",
"initialTrainingAt": "2025-02-15T00:00:00Z",
"nextTrainingAt": "2026-02-15T00:00:00Z",
"deadlineInDays": 60
}
]
}