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:

Available Filters

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} ]

Query Params
int32
≥ 0
Defaults to 0

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

int32
0 to 2000
Defaults to 10

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

Body Params

Workpaper search

SearchCriteriaRequest
Responses

401

Unauthorized

403

Forbidden

404

Not Found

Language
Credentials
OAuth2
Required Scopes
Response
Choose an example:
application/json
*/*