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

Creodock API

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

Получить: реферальную программу

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

OpenAPI: Read the personal referral program without organization scope

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

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

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

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

Параметры

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

ПолеГдеТипОписание
cursorНеобязательно
querystring
Непрозрачный курсор следующей страницы из предыдущего ответа.
limitНеобязательно
queryinteger
Максимальное количество элементов в ответе.Минимум: 1 · Максимум: 50Пример: 8

Ответы

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

200

Referral dashboard

application/json

Схема: ReferralDashboard

ПолеТипОписание
codeОбязательно
string
Поле «code» в структуре запроса или ответа.
dataОбязательно
AccountReferral[]
Элементы текущей страницы результата.
holdDaysОбязательно
integer
Поле «holdDays» в структуре запроса или ответа.
nextCursorОбязательно
object
Непрозрачный курсор следующей страницы; отсутствует на последней странице.
rewardPercentОбязательно
integer
Поле «rewardPercent» в структуре запроса или ответа.
summaryОбязательно
object
Поле «summary» в структуре запроса или ответа.
urlОбязательно
string · uri
Поле «url» в структуре запроса или ответа.
{
  "code": "string",
  "data": [
    {
      "availableAt": "2026-09-05T12:00:00Z",
      "id": "00000000-0000-0000-0000-000000000000",
      "maskedEmail": "string",
      "reason": "string",
      "registeredAt": "2026-09-05T12:00:00Z",
      "reward": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 1
      },
      "status": "registered",
      "tariffPrice": {
        "amountMinor": "string",
        "currency": "string",
        "scale": 1
      }
    }
  ],
  "holdDays": 1,
  "rewardPercent": 1,
  "summary": {},
  "url": "https://example.com/resource"
}