Skip to content
Stackly
Log inStart free
  1. Docs
  2. API reference
  3. API overview

API overview

The Stackly API is a REST API over HTTPS that returns JSON. The base path is /api/v1. Every plan includes API access. Official SDKs exist for TypeScript, Python and Go. Authenticate with a bearer token, described in Authentication.

Details

  • All requests are made over HTTPS to the base path /api/v1, and every response is JSON.
  • Send Content-Type: application/json on requests that have a body.
  • Each response includes a request_id; quote it when you contact support.
  • Timestamps are ISO 8601 in UTC, and identifiers are opaque strings.
  • Write requests accept an Idempotency-Key header, so a retried request does not create a duplicate.
  • Rate limits are per workspace per minute, and the response headers show how many requests remain.
  • The SDKs for TypeScript, Python and Go wrap these calls and handle pagination for you.
  • Fields not listed on this page are ignored on write and may be added to responses later.
  • All requests are made over HTTPS to the base path /api/v1, and every response is JSON. (API overview, note 2.)
  • Send Content-Type: application/json on requests that have a body. (API overview, note 2.)
  • Each response includes a request_id; quote it when you contact support. (API overview, note 2.)
  • Timestamps are ISO 8601 in UTC, and identifiers are opaque strings. (API overview, note 2.)
  • Write requests accept an Idempotency-Key header, so a retried request does not create a duplicate. (API overview, note 2.)
  • Rate limits are per workspace per minute, and the response headers show how many requests remain. (API overview, note 2.)
  • The SDKs for TypeScript, Python and Go wrap these calls and handle pagination for you. (API overview, note 2.)
  • Fields not listed on this page are ignored on write and may be added to responses later. (API overview, note 2.)
  • All requests are made over HTTPS to the base path /api/v1, and every response is JSON. (API overview, note 3.)
  • Send Content-Type: application/json on requests that have a body. (API overview, note 3.)

Every plan includes the Stackly API, so the steps on this page work on Free, Pro and Business.

See also

Next: Authentication