Skip to main content
GET
/
api
/
public
/
v1
/
training
/
enrollments
List enrollments
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/training/enrollments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "course": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "courseType": "<string>"
      },
      "user": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "fullName": "<string>",
        "email": "<string>"
      },
      "status": "not_started",
      "progress": 50,
      "score": 123,
      "enrolledAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "dueDate": "2023-11-07T05:31:56Z",
      "timeSpentSeconds": 123,
      "certificateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "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
​
courseId
string<uuid>

Filter by course ID

​
userId
string<uuid>

Filter by user ID

​
companyId
string<uuid>

Filter by company ID

​
status
enum<string>

Filter by status

Available options:
not_started,
in_progress,
completed

Response

List of enrollments

​
data
object[]
required

Array of enrollments

​
pagination
object
required