Документация · v1

Creodock API

Все операции
GETИнтерфейс Creodock

Получить список: доску заказов

Возвращает доску заказов. Запрос предназначен для чтения и не изменяет данные.

OpenAPI: Read the next page of one Kanban stage

GEThttps://api.creodock.com/api/v1/organizations/{organizationId}/board/columns/{stage}
Кто вызывает
Интерфейс Creodock
Операция выполняется от имени вошедшего пользователя через защищённую cookie-сессию.
Доступ
Определяется ролью и принадлежностью объекта
Отдельный scope не объявлен в OpenAPI. Сервер проверяет роль и рабочую область.

Что произойдёт

Поведение, которое важно учесть до отправки запроса.

  • Не изменяет данные и подходит для безопасного повторного чтения.
  • Повторный запрос возвращает актуальное состояние ресурса.

Параметры

Где передать значение, обязательно ли оно и откуда его получить.

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
stageОбязательно
pathKanbanStage
Идентификатор ресурса в пути запроса: stage.Допустимо: awaiting_payment, unassigned, assigned, in_progress, paused, submitted, revision, completedПример: awaiting_payment
directionIdНеобязательно
querystring · uuid
Параметр фильтрации или управления выдачей: directionId.
qНеобязательно
querystring
Параметр фильтрации или управления выдачей: q.Максимальная длина: 240
clientIdНеобязательно
querystring · uuid
ID клиента, полученный при создании клиента или в ответе списка клиентов.
assigneeIdНеобязательно
querystring · uuid
Параметр фильтрации или управления выдачей: assigneeId.
workTypeIdНеобязательно
querystring · uuid
Параметр фильтрации или управления выдачей: workTypeId.
priorityНеобязательно
queryTaskPriority
Параметр фильтрации или управления выдачей: priority.Допустимо: low, medium, highПример: low
sortНеобязательно
queryQueueSort
Параметр фильтрации или управления выдачей: sort.Допустимо: attention, deadline_asc, deadline_desc, created_descПример: attention
cursorНеобязательно
querystring
Непрозрачный курсор следующей страницы из предыдущего ответа.

Ответы

Все состояния ответа, объявленные этой операцией в OpenAPI.

200

One Kanban column page

application/json

Схема: KanbanColumnPage

ПолеТипОписание
dataОбязательно
KanbanCard[]
Элементы текущей страницы результата.
nextCursorНеобязательно
object
Непрозрачный курсор следующей страницы; отсутствует на последней странице.
stageОбязательно
KanbanStage
Поле «stage» в структуре запроса или ответа.Допустимо: awaiting_payment, unassigned, assigned, in_progress, paused, submitted, revision, completedПример: awaiting_payment
totalОбязательно
integer · int64
Поле «total» в структуре запроса или ответа.
{
  "data": [
    {
      "assignees": [
        {}
      ],
      "availableActions": [
        "assign"
      ],
      "availableMoves": [
        {}
      ],
      "client": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      },
      "creativesCount": 1,
      "deadlineAt": "2026-09-05T12:00:00Z",
      "id": "00000000-0000-0000-0000-000000000000",
      "number": 1,
      "paymentGate": {
        "amount": {},
        "model": "prepay",
        "reason": "string"
      },
      "priority": "low",
      "referencesCount": 1,
      "title": "string",
      "version": 1,
      "workType": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      }
    }
  ],
  "stage": "awaiting_payment",
  "total": 1
}
401

Problem Details response

application/json

Схема: Problem

403

Problem Details response

application/json

Схема: Problem

404

Problem Details response

application/json

Схема: Problem

Ошибки и восстановление

Не только причина, но и конкретное действие для вызывающей стороны.

СтатусЧто означаетПовторЧто делать
401Нет действующей авторизацииПосле авторизацииПроверьте ключ или пользовательскую сессию.
403Недостаточно правНетИспользуйте ключ или роль с требуемым доступом.
404Объект не найден или скрыт правилами доступаНетПроверьте ID и принадлежность рабочей области.

Формат Problem Details

{
  "type": "https://api.creodock.com/problems/invalid-request",
  "title": "Данные не прошли проверку",
  "status": 422,
  "code": "invalid_request",
  "detail": "Проверьте отмеченные поля.",
  "traceId": "req_01J8M4Y6QX",
  "fieldErrors": [
    { "field": "items[0].formats", "code": "required", "message": "Выберите формат." }
  ]
}