Use the REST API

This page will give you an introduction to using Scroll Versions' REST API. If you already know what you're looking for, feel free to skip directly to REST API Resources or a REST API usage example.

The REST API is not officially supported, so changes to the individual resources might occur without notice.

Access REST Documentation for Your App Version

Scroll Versions provides the applicable REST API documentation for download within your app version of Scroll Versions. The downloaded file is in YAML format and can be displayed as an openAPI-format documentation or be imported into a third-party tool like Postman. 

To download this file, access the following URL in your Confluence system: <base-url>/download/resources/com.k15t.scroll.scroll-platform/api-docs/openapi.yaml

Next Steps