Skip to main content

We use cookies for essential site functions and anonymous analytics. Choose what to allow.

Accepts all cookies and closes this banner
Reject All

API Documentation

Complete reference for integrating with our API

Authentication

All API requests require authentication using an API key in the Authorization header.

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.example.com/v1/data

Base URL

All API requests should be made to:

https://api.example.com/v1

Endpoints

GET /data

Retrieve your data records

{
  "data": [
    {
      "id": "123",
      "name": "Example Record",
      "created_at": "2024-01-01T00:00:00Z"
    }
  ],
  "total": 1,
  "page": 1
}

POST /data

Create a new data record

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "New Record"}' \
  https://api.example.com/v1/data

Error Responses

The API returns standard HTTP status codes and error messages:

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request is missing required parameters"
  }
}
cookie_consent.banner.aria_announcement