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 Runn API v1 endpoints are available in a machine-readable format via the OpenAPI v3.1 specification. This spec provides a structured and standardized way to explore and interact with the Runn API programmatically.

For a human-friendly, interactive guide to all available endpoints, visit the Runn API v1 Reference.

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

Watch the video