API и интеграция

Общие соглашения

Формат ответа, пагинация и ошибки.

Все ответы — JSON. Соглашения ниже действуют для всех точек.

Списки с пагинацией

Часть списочных точек возвращает обёртку:

{
  "data": [ ... ],
  "total": 5620,
  "page": 1,
  "limit": 50,
  "totalPages": 113
}
Обёртка есть не у всех списков — некоторые возвращают массив напрямую. Перед интеграцией проверьте форму ответа.

Ошибки

Ответы об ошибке имеют единый вид:

{
  "message": "Эта задача приватная — содержимое видит только исполнитель",
  "error": "Forbidden",
  "statusCode": 403
}

При ошибках валидации message может быть массивом — по строке на поле.