API Documentation

Welcome to the API documentation. This guide will help you understand how to integrate the API into your applications using our REST interface.

Quick Start

Start using the API in just 5 minutes. Follow these steps:

1. Generate an API Key

Log in to the application and go to Settings → API Keys. Click "New Key" and choose permissions.

2. Make Your First Request

Test the connection by getting a list of projects:

curl -X GET "/api/v1/projects" \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Accept: application/json"

3. Explore the Response

A successful response will look like this:

{
  "status": "ok",
  "data": [
    {
      "id": 1,
      "name": "My first project",
      "description": "Project description",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ]
}

Authentication

The API uses Bearer tokens for authentication. Every request must include a valid API key.

Authentication Methods

1. Authorization Header (recommended)

Authorization: Bearer sk_live_your_api_key

2. Query Parameter (for quick tests)

/api/v1/projects?key=sk_live_your_api_key

Key Types

• sk_live_* - Production key, works with real data
• sk_test_* - Test key (coming soon)

Permissions (Scopes)

Rate Limits

The API has limits set to ensure fair access for all users.

Rate Limit Headers

Each response contains information about the current limit status:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 998
X-RateLimit-Reset: 2024-01-15T11:00:00Z

Error Codes

The API uses standard HTTP status codes:

Data Hierarchy

Data is hierarchical. Understanding this structure is key for proper API usage.

• Project - Top level. Contains everything else.
• Todolist - Category/list within a project (e.g., "Backend", "Frontend").
• Todo - The actual task. Always belongs to a todolist.

Projects

List Projects

Get Project

Create Project

$response = $client->post('/api/v1/projects', [
    'json' => [
        'name' => 'New client website',
        'description' => 'Corporate website redesign'
    ]
]);

Update Project

Delete Project

Task Lists (Todolists)

List in Project

Create List

Tasks (Todos)

List Tasks

Get Task

Create Task

// 1. Get todolist ID from project
$lists = $client->get('/api/v1/projects/1/todolists');
$todolistId = $lists['data'][0]['id'];

// 2. Create task in this todolist
$response = $client->post("/api/v1/todolists/{$todolistId}/todos", [
    'json' => [
        'title' => 'Implement new feature',
        'description' => 'Detailed task description...',
        'due_date' => '2024-02-01',
        'assigned_to' => 5
    ]
]);

$newTodo = json_decode($response->getBody(), true);
echo "Created task with ID: " . $newTodo['todo']['id'];

Update Task

Delete Task

Get Merge Candidates

Merge Tasks