API Overview

Base URL

All API endpoints are relative to your Aylesbury instance:

https://aylesbury.io/api/v1

Authentication

All API requests require authentication using an API key. Pass the key in one of two ways:

Authorization Header (Recommended):

Authorization: Bearer YOUR_API_KEY

X-API-Key Header:

X-API-Key: YOUR_API_KEY

Response Format

All responses follow a consistent JSON structure:

Success Response

{
  "data": {
    "id": "resource-slug",
    "type": "resource_type",
    "attributes": { ... },
    "relationships": { ... }
  }
}

Collection Response

{
  "data": [
    { "id": "...", "type": "...", "attributes": { ... } }
  ],
  "meta": {
    "current_page": 1,
    "total_pages": 10,
    "total_count": 250,
    "per_page": 25
  }
}

Error Response

{
  "error": {
    "code": "error_code",
    "message": "Human-readable error message",
    "details": { ... }
  }
}