Skip to content
Docs SuperPlane Docs

Public API Reference

SuperPlane exposes a REST API covering all resources (canvases, integrations, secrets, API keys, and more). The interactive docs list every route and schema.

The full API reference is available as an interactive Swagger document at:

https://app.superplane.com/api/v1/docs

Authentication

Section titled “Authentication”

All API requests require a valid API token sent in the Authorization header:

Authorization: Bearer <API_TOKEN>

For a full overview of authentication methods, see Authentication and accounts.

You can obtain a token in two ways:

  • API key token (recommended for scripts and integrations): see API keys.
  • Personal token (tied to your user): go to Profile > API token in the SuperPlane UI.

Quick example

Section titled “Quick example”
Terminal window
curl -s https://app.superplane.com/api/v1/canvases \
  -H "Authorization: Bearer <API_TOKEN>" | jq

Using with the CLI

Section titled “Using with the CLI”

The SuperPlane CLI wraps the same API. If you prefer a terminal-based workflow, the CLI handles authentication and formatting for you.