GET /v1/goals · Секретный или публичный ключ · право goals:read
Ваши цели сбора от новых к старым. В raised входят сумма, с которой вы начали сбор (поле «Начать сбор с»), и все донаты Донатти в эту цель, включая отклонённые модерацией. Цели Donation Alerts и настройки виджета API не учитывает, поэтому сумма может отличаться от той, что показывает виджет на стриме.
Загружаем справочник…
Параметры, ответы и поля таблицей
Параметры
Заголовок раздела «Параметры»| Имя | Где | Тип | Описание |
|---|---|---|---|
status |
в адресе | строка, значения: ACTIVE, CLOSED |
ACTIVE — сбор идёт, CLOSED — завершён. Без параметра — все цели. |
limit |
в адресе | целое число, 1–100, по умолчанию 20 |
Сколько записей вернуть на странице: от 1 до 100, по умолчанию 20. |
cursor |
в адресе | строка | nextCursor из предыдущего ответа: вернёт следующую страницу. |
200— Успешно400— Параметр не подходит или ключ передан в адресе запроса:invalid_parameter,token_in_query401— Ключа нет, он не найден, удалён или истёк:missing_token,invalid_token,token_expired403— Ключ не того вида, у него нет праваgoals:read, или публичный ключ пришёл с адреса, которого нет в его списке:wrong_token_type,insufficient_scope,origin_not_allowed429— Исчерпан лимит запросов:rate_limited500— Запрос не удался на нашей стороне:internal_error503— API временно недоступен:service_unavailable
Пример ответа
Заголовок раздела «Пример ответа»{ "items": [ { "id": "goal_7e3a9c10-4b2d-4f8e-a1c6-0d9b8e7f6a52", "title": "New microphone", "target": { "value": "15000.00", "currency": "RUB" }, "raised": { "value": "6420.50", "currency": "RUB" }, "status": "ACTIVE", "endsAt": "2026-12-31T21:00:00Z", "createdAt": "2026-10-01T12:00:00Z" } ], "nextCursor": "MTc5MDg1NjAwMDAwMDAwMC43ZTNhOWMxMC00YjJkLTRmOGUtYTFjNi0wZDliOGU3ZjZhNTI"}GoalPage
Заголовок раздела «GoalPage»| Поле | Тип | Описание |
|---|---|---|
items |
список Goal |
|
nextCursor |
строка или null | Передайте как cursor, чтобы получить следующую страницу; null — страница последняя. |
| Поле | Тип | Описание |
|---|---|---|
id |
строка | Идентификатор цели, goal_…. |
title |
строка | Название цели. |
target |
Money |
Сколько нужно собрать. |
raised |
Money |
Сколько собрано: сумма, с которой вы начали сбор (поле «Начать сбор с»), и донаты Донатти в эту цель, включая отклонённые модерацией. |
status |
строка, значения: ACTIVE, CLOSED |
ACTIVE — сбор идёт, CLOSED — завершён. |
endsAt |
строка (дата и время) или null | Когда сбор закончится; null, если срок не задан. |
createdAt |
строка (дата и время) | Когда цель создана. |
| Поле | Тип | Описание |
|---|---|---|
value |
строка | Десятичная сумма с двумя знаками после запятой. |
currency |
строка | Код ISO 4217. |