Sign in
latestOpenAPI 3.1.02026-08-0817082.3 KB

cac8702ed2aa

Learner Training Campaigns

Get learner training campaigns

Get many learner training campaigns. Only learner training campaigns for ACTIVE training campaigns are included in the response.

The query parameter filters are applied as AND conditions across different filters. If multiple filters are used, the response will include only the learner training campaigns that satisfy all the filters.

Within a single filter, multiple values are applied as OR conditions.

get/v1/learner-training-campaigns

Query parameters

idstring[]

Use this parameter to filter learner training campaigns by id.

[
  "ltc789def0"
]
learnerIdstring[]

Use this parameter to filter learner training campaigns by learner id.

[
  "abc123def4"
]
trainingCampaignIdstring[]

Use this parameter to filter learner training campaigns by training campaign id.

[
  "tc456xyz78"
]
learnerStatusstring[]

Use this parameter to filter learner training campaigns by the status of the learner. When omitted, learner training campaigns for learners of all statuses will be included in the response.

[
  "ACTIVE"
]
enrollmentStatusstring[]

Use this parameter to filter learner training campaigns by enrollment status.

[
  "ACTIVE"
]
completionStatusstring[]

Use this parameter to filter learner training campaigns by completion status.

[
  "WITHIN_DEADLINE"
]
limitinteger

Use this parameter to limit the number of entities returned.

cursorstring

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:

  1. GET /v1/{endpoint} → returns data + hasMore: true, last entity id: "xyz789end"
  2. GET /v1/{endpoint}?cursor=xyz789end → returns next page

Response

Success

limitinteger
hasMoreboolean

Example response

{
  "data": [
    {
      "id": "ltc789def0",
      "trainingCampaignId": "tc456xyz78",
      "learnerId": "abc123def4",
      "enrollmentStatus": "ACTIVE",
      "completionStatus": "WITHIN_DEADLINE",
      "nextTrainingAt": "2026-09-01T00:00:00Z",
      "deadline": "2025-12-10T00:00:00Z"
    }
  ]
}