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

Creodock API

Все операции
GETИнтеграция рабочей области

Получить начисления участника

Возвращает финансовые начисления участника без раскрытия чужих данных.

GEThttps://api.creodock.com/api/v1/organizations/{organizationId}/team/members/{memberId}/accruals
Кто вызывает
Интеграция рабочей области
Передайте API-ключ рабочей области в заголовке Authorization: Bearer cdk_live_…
Доступ
finance.read
Все перечисленные права должны быть доступны вызывающей стороне.

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

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

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

Параметры

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

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

Ответы

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

200

Начисления участника

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