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

Creodock API

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

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

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

OpenAPI: Read one client record

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

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

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

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

Параметры

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

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
clientIdОбязательно
pathstring · uuid
ID клиента, полученный при создании клиента или в ответе списка клиентов.

Ответы

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

200

Client record

application/json

Схема: ClientRecord

{
  "activeCreatives": 1,
  "activeOrders": 1,
  "calculations": {
    "available": {
      "amountMinor": "string",
      "currency": "string",
      "scale": 0
    },
    "balance": {
      "amountMinor": "string",
      "currency": "string",
      "scale": 0
    },
    "billingModel": "deposit",
    "debt": {
      "amountMinor": "string",
      "currency": "string",
      "scale": 0
    },
    "debtLimit": {
      "amountMinor": "string",
      "currency": "string",
      "scale": 0
    },
    "expected": {
      "amountMinor": "string",
      "currency": "string",
      "scale": 0
    },
    "freeLimit": {
      "amountMinor": "string",
      "currency": "string",
      "scale": 0
    },
    "lowBalanceThreshold": {
      "amountMinor": "string",
      "currency": "string",
      "scale": 0
    },
    "overdue": {
      "amountMinor": "string",
      "currency": "string",
      "scale": 0
    },
    "paymentTermsDays": 1,
    "reserved": {
      "amountMinor": "string",
      "currency": "string",
      "scale": 0
    }
  },
  "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
}
403

Problem Details response

application/json

Схема: Problem

404

Problem Details response

application/json

Схема: Problem

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

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

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