SapaganDocs sapagan.com

API reference

API reference

Every public route of the native API, with examples in curl and TypeScript.

The native API lives under /v1. This reference is generated from the same openapi.json that the typed client is built from, so it always matches what the API serves.

Conventions#

  • Base URL: your API origin, shown at Settings, Setup, "For your developer". Examples use $SAPAGAN_URL.
  • Auth: Authorization: Bearer <key>. Each operation lists the key kinds that may call it. See API keys.
  • Bodies: JSON, with Content-Type: application/json. Times are ISO 8601 with an offset.
  • Errors: { "error": { "code", "message", "details" } }. See Errors and limits.
  • Idempotency: send Idempotency-Key on a POST you may retry.
  • Not found: a resource the key cannot see is 404, never 403.

What is left out#

This reference lists routes an API key can call. Routes only the console can call (operator login, the operator and platform consoles, view-as-store, and the console-only parts of Setup such as API keys and push credentials) are internal and not listed.

Groups