GET /api/v1/paths/sessions
This route lists all sessions for all paths in the platform. It returns an array with the following data for each session:
sessionId: string, id of the path session.sessionName: string, name of the path session.sessionOwnerGroup: string, id of the group owning the session.sessionCreatedAt: string, date of creation of the session (ISO 8601).sessionModifiedAt: string, date of creation of the session (ISO 8601).instructorsMails: array of strings, list of the emails of the instructors for the session.startDate: string, start date of the session (ISO 8601).endDate: (optional) string, end date of the session (ISO 8601).pathName: string, name of the path.pathId: string, id of the path.pathOwnerGroup: string, id of the group owning the session.pathModifiedAt: string, last modification date of the path (ISO 8601).authorsMail: array of strings, list of the emails of the authors of the path.description: string, description of the path session.lang: language of the path.sourceLang: string, language (bigram) in which the path was originally created.translationLangs: array, list of all additional languages associated to the path. Each element is an object.lang: string, bigram of the language.published: boolean, whether the language is made available for learners or not.translators: array, list of the emails of the translators associated to the language.
pathEstimatedDuration: estimated duration of the pathlinear: true or false. Defines if the steps should be played linearly or notcertificationOutlineId: (optional) id of the certificationsteps: array with the steps included in the pathenrolledGroups: array with the ids of the groups enrolled in the session
Changelog
- Milestone C (March 22): creation of the route
Servers
- https://app.360learning.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
createdBefore |
String | No |
Filter for path sessions created before a certain date, in format ISO 8601. |
createdAfter |
String | No |
Filter for path sessions created after a certain date, in format ISO 8601. |
company |
String | No |
(Optional) Include the company ID to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
modifiedBefore |
String | No |
Filter for path sessions modified before a certain date, in format ISO 8601. |
apiKey |
String | No |
(Optional) Include the API key to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
modifiedAfter |
String | No |
Filter for path sessions modified after a certain date, in format ISO 8601. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.