List training courses

Retrieve a paginated list of training courses. Supports filtering by company, type, category, and mandatory status.

GET /api/public/v1/training/courses

List training courses

cURL

curl --request GET \
  --url https://app.msportal.ai/api/public/v1/training/courses \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "description": "<string>",
      "courseType": "<string>",
      "courseCategory": "<string>",
      "isMandatory": true,
      "passingScore": 123,
      "duration": 123,
      "maxAttempts": 123,
      "expiresAfterDays": 123,
      "artworkUrl": "<string>",
      "youtubeUrl": "<string>",
      "isGlobal": true,
      "company": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "enrollmentCount": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 2,
    "limit": 50,
    "totalCount": 123,
    "totalPages": 123,
    "hasNextPage": true,
    "hasPrevPage": true
  }
}

Authorizations

Authorization · string · header · required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

page · number · default: 1

Page number

Required range: x >= 1

limit · number · default: 25

Items per page

Required range: 1 <= x <= 100

search · string

Search in title and description

Maximum string length: 255

companyId · string<uuid>

Filter by company ID

courseType · string

Filter by course type

courseCategory · string

Filter by category

isMandatory · boolean | null

Filter by mandatory status

includeGlobal · boolean | null · default: true

Include global courses

Response

200

application/json

List of courses

data · object[] · required

Array of courses

Show child attributes

pagination · object · required

Show child attributes