GET /api/v1/paths
Return all paths in the platform.
Fields
_id: string, internal identifier of the path.authorId: string, userId of the author.pathAdditionalInformation: string, contents of the field "Additional path information" in the advanced settings of the path.description: contents of the Description field in the path, if the field is not empty.certificatePDF: certificate of the path.createdAt: string, date and hour of the creation of the path, in ISO 8601 format (UTC).defaultLang: string, language (bigram) marked as "Default Language" in the translation interface of the path.groupId: string, groupId of the path owner group.modifiedAt: string, date and hour of the last modification of the path, in ISO 8601 format (UTC).name: string, name of the path.sessionsIds: array, list the ids of all path sessions created for that path.sourceLang: string, language (bigram) in which the path was originally created.steps: array of the path's steps (course classroom, path, program, assessment)._id: internal identifier of the step.title: title of the steptype: step type, can becourse
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.
Parameters (optional)
You can add the following optional parameters to the query:
&modifiedAfter=AAAA-MM-DD: return paths that have been edited after the specified date (compared to the value of the fieldmodifiedAt).
Servers
- https://app.360learning.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
createdBefore |
String | No |
Optional: filter paths created before the input date (in ISO 8601 format) |
createdAfter |
String | No |
Optional: filter paths created after the input date (in ISO 8601 format) |
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 |
Optional: filter paths modified before the input date (in ISO 8601 format) |
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 |
Optional: filter paths modified after the input date (in ISO 8601 format) |
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.