Документация 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}

Обновить карточку (переместить в другую колонку или subColumn).

# 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}

Значения SubColumn

  • 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.