API

API Reference

Complete API reference documentation for developers.

API Reference

Complete reference for our REST API.

Authentication

All API requests require authentication using an API key:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.yourdomain.com/v1/endpoint

Getting Your API Key

  1. Navigate to Settings > API Keys
  2. Click “Generate New Key”
  3. Copy and securely store your key

Base URL

https://api.yourdomain.com/v1

Endpoints

Projects

List Projects

GET /projects

Response:

{
  "data": [
    {
      "id": "proj_123",
      "name": "My Project",
      "created_at": "2025-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "total": 100,
    "page": 1,
    "per_page": 20
  }
}

Create Project

POST /projects

Body:

{
  "name": "New Project",
  "description": "Project description"
}

Get Project

GET /projects/:id

Update Project

PATCH /projects/:id

Delete Project

DELETE /projects/:id

Users

Get Current User

GET /user

Update User

PATCH /user

Rate Limiting

API requests are limited to:

  • Free: 100 requests/hour
  • Pro: 1,000 requests/hour
  • Enterprise: 10,000 requests/hour

Errors

The API uses standard HTTP status codes:

  • 200 - Success
  • 400 - Bad Request
  • 401 - Unauthorized
  • 403 - Forbidden
  • 404 - Not Found
  • 429 - Rate Limited
  • 500 - Server Error

Error Response:

{
  "error": {
    "code": "invalid_request",
    "message": "The request was invalid"
  }
}

SDKs

We provide official SDKs for:

Webhooks

Subscribe to events using webhooks:

POST /webhooks
{
  "url": "https://your-site.com/webhook",
  "events": ["project.created", "project.updated"]
}

Support

Need help with the API?