Sign in
latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

21de3aa0b170

Training

Get Enrollment Details

❗️ End of Support Notification

As of December 5, 2025, this API is now deprecated. For more information, see OneTrust API Sunsetting & Deprecation Guidelines.

Use this API to retrieve enrollment records for all courses.

🗒 Things to Know

The following are examples of available filters that can be applied:

<details> <summary><b>Available Filters</b></summary>

Organization:

[{"field":"organization","operator":"=","value":”00000000-0000-0000-0000-000000000000"}]

Assignee ID:

[{"field":"assigneeId","operator":"=","value":["00000000-0000-0000-0000-000000000000"]}]
[{"field":"assigneeId","operator":"=","value":["00000000-0000-0000-0000-000000000001","00000000-0000-0000-0000-000000000002"]}]

Assigned Date:

[{"field":"assignedDate","operator":"BW","value":"yyyy-mm-ddT00:00:00.000Z","toValue":"yyyy-mm-ddT00:00:00.000Z"}]

Status:

[{"field":"status","operator":"=","value":["NOT_STARTED"]}]
[{"field":"status","operator":"=","value":["NOT_STARTED","COMPLETED"]}]
Available status values: ["NOT_STARTED","IN_PROGRESS","INCOMPLETE","COMPLETED"]

Score:

[{"field":"score","operator":"BW","value":"00","toValue":"100"}]

Language ID:

[{"field":"languageId","operator":"=","value":["00000000-0000-0000-0000-000000000000"]}]

Deadline:

[{"field":"deadline","operator":"BW","value":"yyyy-mm-ddT00:00:00.000Z","toValue":"yyyy-mm-ddT00:00:00.000Z"}]

Completed Date:

[{"field":"completedDate","operator":"BW","value":"yyyy-mm-ddT00:00:00.000Z","toValue":"yyyy-mm-ddT00:00:00.000Z"}]

Course ID:

[{"field":"courseId","operator":"=","value":["00000000-0000-0000-0000-000000000000"]}]

Multiple Filters:

[ {"field":"courseId","operator":"=","value":["00000000-0000-0000-0000-000000000000"],"additionalInformation":null},
{"field":"status","operator":"=","value":["NOT_STARTED"],"additionalInformation":null} ]

</details>
post/v1/enrollments/assignments

Query parameters

pageinteger

Page number of the results list (0…N).

sizeinteger

The number of elements to be returned in a page. The maximum is 2000, if you exceed 2000 then 2000 is used by default.

Request body

SearchCriteriaRequest required— unresolved $ref

Response

OK

emptyboolean

The flag to check if a result list is empty or not.

firstboolean

The flag to check if the page is the first page or not.

lastboolean

the flag to check if the page is the last page or not.

numberinteger

A number to show the total in the list.

numberOfElementsinteger

Number of total elements returned in the API.

sizeinteger

Size of the list.

totalElementsinteger

Total elements in the return list.

totalPagesinteger

Total pages returned in the list.

Example response

{
  "content": [
    {
      "assigneeId": "f3d38630-9246-45be-898a-69878bd108e4",
      "score": 80,
      "orgGroupId": "f3d38630-9246-45be-898a-69878bd108e4"
    }
  ],
  "numberOfElements": 10,
  "pageable": {
    "offset": 3,
    "pageNumber": 3,
    "pageSize": 23,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true
    }
  },
  "size": 5,
  "sort": {
    "empty": true,
    "sorted": true
  },
  "totalElements": 20,
  "totalPages": 5
}