API Usage Guide

Overview

Our RESTful API enables programmatic access to the core features of the platform. All requests are made over HTTPS and respond with JSON.

Authentication

Use a Bearer token in the Authorization header.

Authorization: Bearer YOUR_API_TOKEN

Generate a token from your API Keys page.

Endpoints

Method Path Description
GET /api/v1/users List all users.
POST /api/v1/users Create a new user.
GET /api/v1/users/:id Retrieve a single user.
PUT /api/v1/users/:id Update a user.
DELETE /api/v1/users/:id Delete a user.

Rate Limits

Each API key is limited to 120 requests per minute. Exceeding this returns 429 Too Many Requests. Implement exponential back‑off for retries.

Example Calls

Fetch the first page of users using fetch in JavaScript:

fetch('https://api.example.com/api/v1/users?page=1', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Accept': 'application/json'
  }
})
.then(res => {
  if (!res.ok) throw new Error(`Error ${res.status}`);
  return res.json();
})
.then(data => console.log(data))
.catch(err => console.error(err));
Full API Docs

Error Handling

All error responses include a JSON body with code and message fields.

{
  "code": "INVALID_PARAMETER",
  "message": "The 'email' field must be a valid email address."
}