List campaigns (campaigns/get-all-campaigns)
Using this method, you can get all current campaigns for the aggregator or store token. The list is provided in batches.
Request
Address for sending the request
POST https://yoomoney.ru/api/offerwall/v1/campaigns/get-all-campaigns
Parameters
The aggregator or store is determined by the token.
Parameter | Type | Description |
---|---|---|
limit | enum | Maximum number of lines (campaigns) in the response. Required parameter |
offset | int | Sequential number of the line (this will be the first line in the downloaded selection). If you need to start from the beginning, offset=0 .Required parameter |
Example of a request body
JSON
{ "limit": 3, "offset": 0 }
Request example
cURL
curl -X POST \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer: <access token>' \ -d '{ "limit": 10, "offset": 0 }' 'https://yoomoney.ru/api/offerwall/v1/campaigns/get-all-campaigns'
Response
Parameters
Parameter | Type | Description |
---|---|---|
total | enum | Total number of campaigns from this aggregator or store. |
campaigns | array of objects | List of all campaigns. |
ymCampaignId | int | Unique ID of the campaign in the YooMoney service. |
campaignStatus | enum | Campaign status |
Example of a response body
JSON
{ "status": "success", "total": 3, "campaigns": [ { "ymCampaignId": 41, "campaignStatus": "finished" }, { "ymCampaignId": 42, "campaignStatus": "started" }, { "ymCampaignId": 43, "campaignStatus": "started" } ] }