Документація API TaskLeef

REST API для керування завданнями, проєктами та kanban-дошками

Останнє оновлення:

− Автентифікація

API підтримує два методи автентифікації:

1. Автентифікація за ключем API (рекомендовано)

Generate an API key from your Settings page and include it in the X-API-Key header:

curl -H "X-API-Key: your-api-key" \
  https://taskleef.com/api/todos

2. Bearer-токен JWT

Для застосунків у браузері автентифікуйтеся через ендпоінт входу:

curl -X POST https://taskleef.com/api/login \
  -H "Content-Type: application/json" \
  -d '{"username": "your-username", "password": "your-password"}'

Потім додайте токен до наступних запитів:

curl -H "Authorization: Bearer your-jwt-token" \
  https://taskleef.com/api/todos

− Завдання

GET/api/todos

Отримати всі завдання автентифікованого користувача.

curl -H "X-API-Key: your-api-key" \
  https://taskleef.com/api/todos
GET/api/todos/{id}

Отримати конкретне завдання за ID.

GET/api/inbox

Отримати завдання, не призначені до жодного проєкту.

POST/api/todos

Створити нове завдання.

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"title": "Buy groceries", "description": "Milk, eggs, bread"}' \
  https://taskleef.com/api/todos

Тіло запиту

ПолеТипОбов'язковеОпис
titlestringYesTodo title
descriptionstringNoDetailed description
dueDateISO 8601NoDue date/time
prioritystringNoLow, Medium, High, or Urgent
projectIdUUIDNoAssign to a project
PUT/api/todos/{id}

Оновити наявне завдання.

PATCH/api/todos/{id}/complete

Перемкнути статус виконання завдання.

curl -X PATCH -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"isCompleted": true}' \
  https://taskleef.com/api/todos/{id}/complete
DELETE/api/todos/{id}

Видалити завдання.

POST/api/todos/{parentId}/subtasks

Створити підзавдання в батьківському завданні.

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"title": "Subtask title"}' \
  https://taskleef.com/api/todos/{parentId}/subtasks

− Проєкти

GET/api/projects

Отримати список усіх проєктів автентифікованого користувача.

POST/api/projects

Створити новий проєкт.

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"title": "Work Tasks", "description": "Tasks for work"}' \
  https://taskleef.com/api/projects
GET/api/projects/{id}

Отримати конкретний проєкт з його завданнями.

PUT/api/projects/{id}

Оновити проєкт.

DELETE/api/projects/{id}

Видалити проєкт (завдання переносяться до Вхідної теки).

− Kanban-дошки

GET/api/boards

Отримати список усіх дошок, до яких має доступ користувач.

POST/api/boards

Створити нову дошку.

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"title": "Sprint Board", "projectId": "project-uuid"}' \
  https://taskleef.com/api/boards
GET/api/boards/{id}

Отримати конкретну дошку.

GET/api/boards/{boardId}/columns

Отримати всі стовпці дошки.

GET/api/boards/{boardId}/todos

Отримати всі завдання, що мають картки на цій дошці.

− Стовпці

POST/api/boards/{boardId}/columns

Створити новий стовпець на дошці.

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"title": "In Progress", "wipLimit": 3}' \
  https://taskleef.com/api/boards/{boardId}/columns
PUT/api/columns/{id}

Оновити стовпець (назва, ліміт WIP, критерії готовності).

GET/api/columns/{columnId}/cards

Отримати всі картки у стовпці.

DELETE/api/columns/{id}

Видалити стовпець.

− Картки

Картки представляють завдання на kanban-дошці. Завдання може мати картки на кількох дошках.

POST/api/columns/{columnId}/cards

Створити картку для завдання у стовпці.

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"todoId": "todo-uuid"}' \
  https://taskleef.com/api/columns/{columnId}/cards
PUT/api/cards/{id}

Оновити картку (перенести до іншого стовпця або підстовпця).

# Move card to a different column
curl -X PUT -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"columnId": "new-column-uuid", "subColumn": "Inbox"}' \
  https://taskleef.com/api/cards/{id}

# Move card to Done subColumn
curl -X PUT -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"subColumn": "Done"}' \
  https://taskleef.com/api/cards/{id}

Значення підстовпців

  • Inbox - Active items in the column
  • Done - Completed items within the column
  • Blocked - Items waiting on external dependencies
DELETE/api/cards/{id}

Видалити картку з дошки (не видаляє завдання).

− Теги

GET/api/tags

Отримати список усіх тегів автентифікованого користувача.

POST/api/tags

Створити новий тег.

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"name": "urgent"}' \
  https://taskleef.com/api/tags
PUT/api/tags/{id}

Оновити тег.

DELETE/api/tags/{id}

Видалити тег.

− Коментарі

GET/api/todos/{todoId}/comments

Отримати всі коментарі до завдання.

POST/api/todos/{todoId}/comments

Додати коментар до завдання.

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"text": "This is my comment"}' \
  https://taskleef.com/api/todos/{todoId}/comments
PUT/api/comments/{id}

Оновити коментар.

DELETE/api/comments/{id}

Видалити коментар.

− Формат відповіді

Успішні відповіді

Успішні запити повертають JSON із запитаними даними:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "title": "Buy groceries",
  "description": "Milk, eggs, bread",
  "isCompleted": false,
  "createdAt": "2024-01-15T10:30:00Z"
}

Відповіді з помилками

Помилки повертають відповідні коди стану HTTP:

  • 400 - Bad Request (invalid input)
  • 401 - Unauthorized (missing or invalid authentication)
  • 403 - Forbidden (insufficient permissions)
  • 404 - Not Found
  • 500 - Internal Server Error

Need help? Check your Settings to manage API keys.