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

Creodock API

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

Получить список: клиентов

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

OpenAPI: List workspace clients

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

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

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

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

Параметры

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

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
qНеобязательно
querystring
Параметр фильтрации или управления выдачей: q.Максимальная длина: 240
billingModelНеобязательно
queryClientBillingModel
Параметр фильтрации или управления выдачей: billingModel.Допустимо: deposit, postpay, prepayПример: deposit
attentionНеобязательно
querystring
Параметр фильтрации или управления выдачей: attention.Допустимо: requiredПример: required
sortНеобязательно
queryClientSort
Параметр фильтрации или управления выдачей: sort.Допустимо: activity_desc, created_desc, orders_desc, available_desc, debt_desc, name_ascПример: activity_desc
cursorНеобязательно
querystring
Непрозрачный курсор следующей страницы из предыдущего ответа.
limitНеобязательно
queryinteger
Максимальное количество элементов в ответе.Минимум: 1 · Максимум: 100Пример: 20

Ответы

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

200

Client page

application/json

Схема: ClientListResponse

ПолеТипОписание
dataОбязательно
ClientListItem[]
Элементы текущей страницы результата.
filtersОбязательно
object
Поле «filters» в структуре запроса или ответа.
nextCursorНеобязательно
object
Непрозрачный курсор следующей страницы; отсутствует на последней странице.
totalОбязательно
integer
Поле «total» в структуре запроса или ответа.
{
  "data": [
    {
      "activeCreatives": 1,
      "activeOrders": 1,
      "calculations": {
        "available": {},
        "balance": {},
        "billingModel": "deposit",
        "debt": {},
        "debtLimit": {},
        "expected": {},
        "freeLimit": {},
        "lowBalanceThreshold": {},
        "overdue": {},
        "paymentTermsDays": 1,
        "reserved": {}
      },
      "contactsCount": 1,
      "id": "00000000-0000-0000-0000-000000000000",
      "lastActivityAt": "2026-09-05T12:00:00Z",
      "lastActivityType": "string",
      "name": "string",
      "primaryContact": {
        "createdAt": "2026-09-05T12:00:00Z",
        "id": "00000000-0000-0000-0000-000000000000",
        "isPrimary": true,
        "name": "string",
        "telegram": "string",
        "version": 1
      },
      "version": 1
    }
  ],
  "filters": {
    "billingModels": [
      "deposit"
    ]
  },
  "total": 1
}
403

Problem Details response

application/json

Схема: Problem

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

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

СтатусЧто означаетПовторЧто делать
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": "Выберите формат." }
  ]
}