v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB

Paths

List all enrollments

🔑

Required OAuth scope: paths:read.

📖

This endpoint is paginated with a page size of 5,000 enrollments. For more information, see the Pagination guide.

Lists all enrollments for the given path.

get/api/v2/paths/{pathId}/enrollments

Path parameters

pathIdstring ObjectId required

Example:507f1f77bcf86cd799439011

The unique ID of the path.

Query parameters

eq'archived' | 'published'

Filter on values equal to the given one

Filter on status property with LHS bracket notation.

Expected value format is a string (archived, published).

{
  "eq": "archived"
}

ltstring date-time

Filter on dates lower than the given one

gtestring date-time

Filter on dates greater than or equal the given one

Filter on createdAt property with LHS bracket notation.

Expected value format is a date (YYYY-MM-DDThh:mm:ss.sssZ). The milliseconds are always set to 0.

{
  "lt": "2020-01-01T10:30:26.000Z",
  "gte": "2020-01-01T10:30:26.000Z"
}

ltstring date-time

Filter on dates lower than the given one

gtestring date-time

Filter on dates greater than or equal the given one

Filter on modifiedAt property with LHS bracket notation.

Expected value format is a date (YYYY-MM-DDThh:mm:ss.sssZ). The milliseconds are always set to 0.

{
  "lt": "2020-01-01T10:30:26.000Z",
  "gte": "2020-01-01T10:30:26.000Z"
}

eqstring ObjectId

Filter on values equal to the given one

nestring ObjectId

Filter on values not equal to the given one

instring[]

Filter on values including the given ones

ninstring[]

Filter on values excluding the given ones

Filter on sessionId property with LHS bracket notation.

Expected value format is a valid ID (24 digits or letters).

{
  "eq": "507f1f77bcf86cd799439011",
  "ne": "507f1f77bcf86cd799439011",
  "in": [
    "507f1f77bcf86cd799439011"
  ],
  "nin": [
    "507f1f77bcf86cd799439011"
  ]
}

Headers

360-api-version'v2.0' required

The version of the API.

Response

Returns one page of 5000 enrollments.

_idstring ObjectId required

The unique ID of the user enrollment.

archivedAtstring date-time

The date and time when the enrollment was archived from the path session, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

createdAtstring date-time required

The date and time when the learner enrolled to the path session, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

isSelfEnrolledboolean required

True if the user self-enrolled in the given path session; false otherwise.

modifiedAtstring date-time

The date and time when the learner enrollment has been updated, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

sessionIdstring ObjectId required

The unique ID of the path session.

status'archived' | 'published' required

The status of the enrollment.

userIdstring ObjectId required

The unique ID of the user.

Example response

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "sessionId": "507f1f77bcf86cd799439011",
    "userId": "507f1f77bcf86cd799439011"
  }
]