Getting Started

Authentication

All API requests require an API key passed via the Authorization header or X-API-Key header.

Making your first request

Let's list your cases:

Example response

{
  "cases": [
    {
      "id": "clx...",
      "reference": "CW-2026-0042",
      "status": "open",
      "publicSummary": "Pothole on High Street near junction with Mill Lane",
      "wardId": "ward-123",
      "categoryId": "cat-456",
      "createdAt": "2026-01-15T10:30:00.000Z",
      "updatedAt": "2026-01-15T10:30:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "total": 42,
    "totalPages": 3
  }
}

Rate limits

API requests are limited to 100 requests per minute per API key.

When you exceed the limit, the API returns 429 Too Many Requests with a Retry-After header indicating how many seconds to wait.

Error format

All errors return a JSON body with an error field:

{
  "error": "Invalid API key",
  "details": {}
}

Scopes

API keys are created with specific scopes that control what they can access: