Sign in
Training Campaigns

Get a training campaign by id

Get a training campaign.

get/v1/training-campaigns/{id}

Path parameters

idstring required

The unique identifier of a training campaign.

Example:tc456xyz78

Response

Success

idstring required

The unique identifier of a training campaign.

courseNamestring required

The name of the course.

campaignNamestring required

The name of the training campaign.

status'ACTIVE' | 'ARCHIVED' required

The status of the training campaign. ACTIVE campaigns may be scheduling training now and/or in the future. ARCHIVED campaigns have been deactivated and will no longer schedule new training.

initialTrainingAtstring date-time required

The date and time when the training campaign is scheduled to start.

nextTrainingAtstring date-time

The date and time when the next training session is scheduled to start.

deadlineInDaysinteger

The number of days before the deadline of the training campaign. The deadline can be calculated as initialTrainingAt, plus the number of days specified in this field. If the deadline in days is null, then the training campaign does not have a deadline.

Example response

{
  "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
}

Changes

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