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

Creodock API

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

Получить список: рабочая область

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

OpenAPI: List direction-scoped creative records and their current review state

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

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

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

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

Параметры

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

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
directionIdНеобязательно
querystring · uuid
Параметр фильтрации или управления выдачей: directionId.
qНеобязательно
querystring
Параметр фильтрации или управления выдачей: q.
clientIdНеобязательно
querystring · uuid
ID клиента, полученный при создании клиента или в ответе списка клиентов.
taskIdНеобязательно
querystring · uuid
ID заказа, полученный при создании заказа или в ответе списка заказов.
reviewStatusНеобязательно
queryCreativeReviewStatus
Параметр фильтрации или управления выдачей: reviewStatus.Допустимо: draft, submitted, changes_requested, approved, archivedПример: draft
cursorНеобязательно
querystring
Непрозрачный курсор следующей страницы из предыдущего ответа.

Ответы

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

200

Creative library

application/json

Схема: CreativeLibraryResponse

ПолеТипОписание
countsОбязательно
object
Поле «counts» в структуре запроса или ответа.
dataОбязательно
CreativeListItem[]
Элементы текущей страницы результата.
nextCursorНеобязательно
object
Непрозрачный курсор следующей страницы; отсутствует на последней странице.
totalОбязательно
integer
Поле «total» в структуре запроса или ответа.
{
  "counts": {},
  "data": [
    {
      "approvedVersion": {},
      "aspectRatio": "string",
      "author": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      },
      "availableActions": [
        "string"
      ],
      "client": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      },
      "currentVersion": {
        "assets": [],
        "author": {},
        "createdAt": "2026-09-05T12:00:00Z",
        "id": "00000000-0000-0000-0000-000000000000",
        "number": 1
      },
      "directionId": "00000000-0000-0000-0000-000000000000",
      "geo": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "language": "string",
      "number": "string",
      "reviewStatus": "draft",
      "reviewer": {},
      "task": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      },
      "title": "string",
      "type": "static",
      "updatedAt": "2026-09-05T12:00:00Z",
      "version": 1
    }
  ],
  "total": 1
}
401

Problem Details response

application/json

Схема: Problem

403

Problem Details response

application/json

Схема: Problem

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

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

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

Формат 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": "Выберите формат." }
  ]
}