REST API Documentation

🔐 Authentication

All API requests must be authenticated with a Bearer token. Add your API key in an Authorization header.

Authentication Headers

Authorization: Bearer YOUR_API_KEY

Token Scope Management

Read-only access

read:resources

Write access

write:resources

Admin privileges

admin:full

🚦 API Endpoints

Available Resources

Users

Create and manage user accounts

POST /api/v1/users

GET /api/v1/users/{id}

Projects

Manage project resources

POST /api/v1/projects

GET /api/v1/projects?query=

Tasks

Task management endpoint

GET /api/v1/tasks

PATCH /api/v1/tasks/{id}

Example Request

POST application/json

curl -X POST https://api.example.com/api/v1/users \\ -H "Authorization: Bearer YOUR_API_KEY" \\ -H "Content-Type: application/json" \\ -d '{"name":"John Doe","email":"john@example.com"}'

Request Body

{
  "name": "string",
  "email": "string (email format)",
  "role": "enum[user,admin]",
  "projects": "array of project IDs"
}

Example Response

201 Created application/json

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "John Doe",
  "email": "john@example.com",
  "role": "user",
  "created_at": "2025-01-15T10:30:00Z"
}

🛑 Error Responses

401 Unauthorized

{"error":"Authentication required"}

Missing or invalid API token

429 Too Many Requests

{"error":"Rate limit exceeded","retry_after":"60s"}

Exceeded API request limits