The API reference
A predictable, typed REST API with sensible defaults.
Basics
REST, done right
JSON everywhere, cursor pagination, and clear error codes.
- ✓Bearer-token auth
- ✓Idempotent writes
- ✓Webhooks for every event
🔌
10k+
Monthly visitors
99.9%
Uptime
4.9★
Average rating
<1s
Load time
Highlights
What you get
🔑
POST /auth/token
Exchange credentials for an access token.
👤
GET /users/:id
Fetch a single user by id.
📦
GET /resources
List resources with cursor pagination.
✏️
PATCH /resources/:id
Partially update a resource.
🗑️
DELETE /resources/:id
Remove a resource (idempotent).
🪝
POST /webhooks
Subscribe to real-time events.
Examples
Common requests
Authenticate+
curl -X POST /auth/token -d '{ "key": "..." }' — returns a bearer token valid for 24h.
List with pagination+
GET /resources?limit=20&cursor=... — responses include a next_cursor field.
Handle errors+
Every error returns a JSON body with a code and message, plus the right HTTP status.