API Overview

The stemp API is a RESTful JSON API. This page covers the conventions used across all endpoints.

Base URL

https://api.stemp.app/api

All API paths are relative to this base URL. For example, the users endpoint is available at https://api.stemp.app/api/v1/users.

Authentication

Include your access token in the Authorization header:

Authorization: Bearer <access_token>

See the Authentication guide for details on obtaining tokens.

Request Format

• Use Content-Type: application/json for request bodies.
• Query parameters should be URL-encoded.

Response Format

All responses return JSON. Successful responses use standard HTTP status codes:

Error Format

Error responses return a JSON object with a code field and optional params:

{
  "code": "resource_not_found",
  "params": null
}

Validation errors use a different structure with field-level messages:

{
  "STANDARD_VALIDATION": {
    "name": "must not be blank",
    "email": "must be a valid email address"
  }
}

See the Error Handling guide for full details.

Pagination

List endpoints support cursor-based pagination:

Rate Limiting

API requests are rate-limited. When you hit the limit, you receive a 429 response with a Retry-After header indicating when you can retry.

Interactive Reference

Explore all endpoints interactively in the API Reference.