elf.org

API Documentation

Introduction

Welcome to the elf.org API documentation. This guide will help you understand how to interact with our platform's features programmatically.

Authentication

All API endpoints require a valid API key in the Authorization header.

Base URL

https://api.elf.org/v1

Endpoints

Resources

GET /resources
POST /resources
GET /resources/{id}
PUT /resources/{id}
DELETE /resources/{id}
                

Manage your resources with CRUD operations. Requires application/json content type.

Users

GET /users
POST /users
GET /users/{id}
PATCH /users/{id}
                

User management operations. PATCH requires application/merge-patch+json.

Events

GET /events
POST /events
GET /events/{id}
                

Event creation and listing. Requires application/json content type.

Authentication

API Key Authentication

Authorization: Bearer <your_api_key>
                

OAuth2 Authentication

For third-party applications, use our OAuth2 flow to obtain an access token:

POST /auth/oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials
client_id=your_client_id
client_secret=your_client_secret
                

Error Handling

API errors are returned in standardized JSON format with appropriate HTTP status codes:

{
  "error": "invalid_request",
  "message": "Invalid authorization header",
  "code": 401
}
            
  • • 400 – Bad Request
  • • 401 – Unauthorized
  • • 403 – Forbidden
  • • 404 – Resource Not Found
  • • 429 – Too Many Requests
  • • 500 – Internal Server Error

Rate Limits

Standard API Tier

  • • 6000 Requests/minute
  • • 100 Concurrent Connections
  • • 1000 MB Bandwidth

Premium API Tier

  • • 50000 Requests/minute
  • • 500 Concurrent Connections
  • • 5000 MB Bandwidth

Rate limits are enforced per API key. You can check your rate limit status using the Rate-Limit-Remaining header.