Skip to main content
The Sleekplan REST API exposes the same data you see in the dashboard. This page is an orientation guide; the full endpoint reference — parameters, request bodies, responses — is in the sidebar under Endpoints and Endpoints (v2).

​
What the API covers

​
Two namespaces, one key

/v1 and /v2 run side by side. /v2 is where new endpoints are built, but nothing about /v1 is deprecated or scheduled for removal, and a single API key authenticates both — you can call either from the same integration. If you are integrating today, use /v1 for the resources it covers and /v2 for the ones only it has. API v2 describes its response codes, pagination, and stability promise in full.

​
Authentication

The API uses an API key sent as Authorization: Bearer YOUR_API_KEY. Get yours from Settings → Developer in the dashboard; see API keys for how to create, use, and rotate them.
/v1 also accepts Basic auth (-u YOUR_API_KEY:, trailing colon, no password) and an ?api_key= query parameter. /v2 accepts neither — send a Bearer token.

API v2

Response codes, pagination, stability.

MCP Server

Natural-language access.

Webhooks

React to events without polling.

​
Choosing the right integration

  • REST API — query or write Sleekplan data on demand from your backend.
  • Webhooks — react to events without polling.
  • MCP server — natural-language access from an AI assistant.
  • Canvas (Custom Integration) — render interactive UI inside Sleekplan Admin; see Canvas overview.
Many integrations combine webhooks (event triggers) with the REST API (on-demand reads/writes).