Getting Started with the Runn API

Overview

The Runn API uses REST principles, exposing predictable resource-oriented URLs. It accepts request bodies and exposes data via JSON encoding. Errors are communicated via standard HTTP response codes.

The Runn API v1 can be accessed via https://api.runn.io, unless you have been provided a different URL (check in "Settings > API" in the Runn app). Only administrators in your Runn account can see this page.

All API endpoints are documented in a machine-readable way through the OpenAPI v3 standard. All available endpoints are listed in the API v1 Reference

Browse the following sections to learn all about using the Runn API

Authentication
Test Account
Versioning
Usage
Pagination
Rate limits
Errors