ADadaptivesecurity
Training

Get training campaign details

Changed on

Retrieve detailed information about a specific training campaign

Required permission: training:read

get/v2/training/campaigns/{campaignId}

Request

  • Base URL
    https://api.adaptivesecurity.com
  • URL
    https://api.adaptivesecurity.com/v2/training/campaigns/{campaignId}
  • Auth
    HTTP bearer

Path parameters

campaignIdstring required

Campaign ID

Response

Successfully retrieved training campaign details

audience_type'GROUPS' | 'ALL_USERS'

Target audience type for the campaign

created_atstring date-time

Campaign's created date

employee_titlestring nullable

Employee-facing title for the campaign. Null if no employee-facing title is set.

end_datestring date-time nullable

End date for the campaign (null for TRIGGERED mode)

idstring

Unique identifier for the campaign

mode'SCHEDULED' | 'TRIGGERED'

Campaign mode

namestring

Name of the training campaign

start_datestring date-time

Start date for the campaign

status'DRAFT' | 'SCHEDULED' | 'IN_PROGRESS' | 'COMPLETED' | 'OVERDUE'

Current status of the campaign

Example response

{
  "audience_type": "GROUPS",
  "created_at": "2025-01-01T13:19:13.402Z",
  "employee_title": "2024 Annual Security Training",
  "end_date": "2025-01-01T13:19:13.402Z",
  "groups": [
    {
      "id": "e7f89a36-4b8f-4865-b11a-b0f280ae6a34",
      "name": "Finance Team"
    }
  ],
  "id": "e7f89a36-4b8f-4865-b11a-b0f280ae6a34",
  "mode": "SCHEDULED",
  "name": "Engineering Annual Training",
  "start_date": "2025-01-01T13:19:13.402Z",
  "status": "IN_PROGRESS"
}

Changes

  • 9ce896e97db1Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status