Fundraising goals
GET /v1/goals · Secret or public key · scope goals:read
Your fundraising goals, newest first. raised includes the amount you started the goal with (the «Начать сбор с» (Start collecting from) field) and every Donatty donation to the goal, including ones rejected by moderation. Donation Alerts goals and widget settings are not counted, so the amount may differ from what the widget shows on stream.
Loading the reference…
Parameters, responses and fields as tables
Parameters
Section titled “Parameters”| Name | In | Type | Description |
|---|---|---|---|
status |
query | string, values: ACTIVE, CLOSED |
ACTIVE — the goal is running, CLOSED — it is finished. Without it, all goals. |
limit |
query | integer, 1–100, default 20 |
How many records to return per page: 1 to 100, 20 by default. |
cursor |
query | string | nextCursor from the previous response; returns the next page. |
Responses
Section titled “Responses”200— OK400— A parameter is invalid, or the key was sent in the request address:invalid_parameter,token_in_query401— The key is missing, unknown, deleted or expired:missing_token,invalid_token,token_expired403— Wrong kind of key, the key lacks thegoals:readscope, or the public key came from an address that is not in its list:wrong_token_type,insufficient_scope,origin_not_allowed429— Rate limit exceeded:rate_limited500— The request failed on our side:internal_error503— The API is temporarily unavailable:service_unavailable
Example response
Section titled “Example response”{ "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"}Schemas
Section titled “Schemas”GoalPage
Section titled “GoalPage”| Field | Type | Description |
|---|---|---|
items |
list Goal |
|
nextCursor |
string or null | Pass as cursor to get the next page; null — last page. |
| Field | Type | Description |
|---|---|---|
id |
string | Goal identifier, goal_…. |
title |
string | Goal title. |
target |
Money |
The amount to raise. |
raised |
Money |
The amount raised: the amount you started the goal with (the «Начать сбор с» (Start collecting from) field) plus Donatty donations to this goal, including ones rejected by moderation. |
status |
string, values: ACTIVE, CLOSED |
ACTIVE — running, CLOSED — finished. |
endsAt |
string (date-time) or null | When the goal ends; null when no end is set. |
createdAt |
string (date-time) | When the goal was created. |
| Field | Type | Description |
|---|---|---|
value |
string | Decimal amount with two fraction digits. |
currency |
string | ISO 4217 code. |