List Campaigns

Get list of all campaigns.

GET /cabinet/admin/campaigns

List Campaigns

cURL

curl --request GET \
  --url https://api.example.com/cabinet/admin/campaigns \
  --header 'Authorization: Bearer <token>'

200

{
  "campaigns": [
    {
      "id": 123,
      "name": "<string>",
      "start_parameter": "<string>",
      "is_active": true,
      "registrations_count": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "total_revenue_kopeks": 0,
      "conversion_rate": 0,
      "partner_user_id": 123,
      "partner_name": "<string>"
    }
  ],
  "total": 123
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

include_inactive · boolean · default: true

offset · integer · default: 0

Required range: x >= 0

limit · integer · default: 50

Required range: 1 <= x <= 100

Response

200

application/json

Successful Response

Response with list of campaigns.

campaigns · CampaignListItem · object[] · required

Show child attributes

total · integer · required