GET /api/v1/paths/sessions/{sessionId}/users
This route returns all the learners enrolled to a specific Path session.
Error messages
| Status code | Error body | Reason |
|---|---|---|
404 | { error: session_not_found } | If the sessionId is not found |
404 | { error: session_not_found } | If the sessionId does not belong to the company |
400 | { error: bad_request] } | If the request is not valid |
401 | { error: unauthorized } | If apiKey is not included |
401 | { error: unauthorized } | If apiKey is not valid |
Changelog
- Milestone Z (Jan 22): Creation of the route
Servers
- https://app.360learning.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
sessionId |
String | Yes |
Id of the Path session |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
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. |
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. |
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.