Skip to main content

ListClassEnrollments

GET /tp-api/classes/:classId/enrollments

Retrieve a list of enrollments for a class.

Path Parameters
  • classId string required

    Class ID

Query Parameters
  • cursor string

    Cursor to return items after a specific position in the list.

  • limit integer

    Possible values: >= 1 and <= 100

    Default value: 10

    Maximum number of items to return.

  • skip integer

    Query to retrieve the items starting from that position in the dataset.

Header Parameters
  • training-provider-id string required
Responses

Default Response

Schema
  • Array [
  • id string required
  • learner object required
  • id string required
  • firstname string required
  • lastname string required
  • uniqueSystemIdentifier string required
  • email string required
  • phone string required
  • employer object required
  • anyOf
  • id string required
  • name string required
  • enrolledAt date-time required

    The enrollment timestamp, should be in ISO8601 format.

  • ]
    • Loading...