v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB

Paths

List all sessions

🔑

Required OAuth scope: paths:read.

📖

This endpoint is paginated with a page size of 500 path sessions. For more information, see the Pagination guide.

Lists all path sessions in your platform. This endpoint does not return path session translations. To retrieve translations, use the Retrieve a path session endpoint or the List all sessions in a path endpoint.

get/api/v2/paths/sessions

Query parameters

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

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 startDate 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 endDate 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"
  ]
}

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 pathId 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 500 path sessions.

mainInstructorIdstring ObjectId required

The unique ID of the main instructor of the path session.

registrationRequestValidation'disabled' | 'instructors' | 'managers' | 'adminsAndManagers' | 'adminsCoachesInstructorsManagers' required

The registration request validation options for open access registrations. Options are:

disabled: There is no validation for registration.
instructors: The instructors validate the registration request.
managers: The managers validate the registration request.
adminsAndManagers: The managers and group admin validate the registration request.
adminsCoachesInstructorsManagers:Managers, instructors, group admins and coaches validate the registration request.

startDatestring date-time required

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

endDatestring date-time

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

userLimitinteger

The maximum number of learners that can self enroll in the path session.

_idstring ObjectId required

The unique ID of the path session.

createdAtstring date-time required

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

groupIdstring ObjectId required

The unique ID of the path session owner group.

instructorIdsstring[] required

The list of unique IDs of the co-instructors of the path session.

isAudienceBuilderboolean required

True if the path session is an audience builder session; false otherwise.

modifiedAtstring date-time required

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

namestring required

The title of the path session.

pathIdstring ObjectId required

The unique ID of the path the session belongs to.

additionalInformationstring

The additional information of the path session.

rootSessionIdstring ObjectId

The unique ID of the root session.

Example response

[
  {
    "mainInstructorId": "507f1f77bcf86cd799439011",
    "automaticReenrollment": {
      "delayDays": 90
    },
    "_id": "507f1f77bcf86cd799439011",
    "groupId": "507f1f77bcf86cd799439011",
    "instructorIds": [
      "507f1f77bcf86cd799439011"
    ],
    "name": "Employee Onboarding October Session.",
    "pathId": "507f1f77bcf86cd799439011",
    "additionalInformation": "A0015221",
    "rootSessionId": "507f1f77bcf86cd799439011"
  }
]