Skip to main content

REST API

The Erold REST API provides 68+ endpoints for full programmatic access to your workspace. Build integrations, automate workflows, or create custom tools.

Base URL

https://api.erold.dev/v1

Authentication

All API requests require authentication via API key. Include your key in the Authorization header: 

curl https://api.erold.dev/v1/projects \
  -H "Authorization: Bearer erold_your_api_key_here"

Get your API key from Settings → API Keys in the web app.

Response Format

All responses use a consistent JSON structure:

// Success response
{
  "data": { ... },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "requestId": "req_abc123"
  }
}

// Error response
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Task not found",
    "details": { ... }
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "requestId": "req_abc123"
  }
}

HTTP Status Codes

Code Meaning
200 Success
201 Created
400 Bad request - check your input
401 Unauthorized - invalid or missing API key
403 Forbidden - insufficient permissions
404 Not found
429 Rate limited - slow down
500 Server error

Pagination

List endpoints support pagination:

GET /v1/tasks?page=2&limit=50

Response includes pagination metadata:

{
  "data": [...],
  "meta": {
    "pagination": {
      "page": 2,
      "limit": 50,
      "total": 150,
      "totalPages": 3
    }
  }
}

Quick Examples

List Projects

curl https://api.erold.dev/v1/projects \
  -H "Authorization: Bearer erold_xxx"

Create a Task

curl -X POST https://api.erold.dev/v1/tasks \
  -H "Authorization: Bearer erold_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "projectId": "proj_abc123",
    "title": "Implement auth",
    "priority": "high"
  }'

Update Task Status

curl -X PATCH https://api.erold.dev/v1/tasks/MYAPP-123 \
  -H "Authorization: Bearer erold_xxx" \
  -H "Content-Type: application/json" \
  -d '{"status": "done"}'

API Sections