Get Campaign

Get detailed campaign info.

GET /cabinet/admin/campaigns/{campaign_id}

Get Campaign

cURL

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

200

{
  "id": 123,
  "name": "<string>",
  "start_parameter": "<string>",
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "balance_bonus_kopeks": 0,
  "balance_bonus_rubles": 0,
  "subscription_duration_days": 123,
  "subscription_traffic_gb": 123,
  "subscription_device_limit": 123,
  "subscription_squads": [
    "<string>"
  ],
  "tariff_id": 123,
  "tariff_duration_days": 123,
  "tariff": {
    "id": 123,
    "name": "<string>"
  },
  "partner_user_id": 123,
  "partner_name": "<string>",
  "created_by": 123,
  "updated_at": "2023-11-07T05:31:56Z",
  "deep_link": "<string>",
  "web_link": "<string>"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

campaign_id · integer · required

Response

200

application/json

Successful Response

Detailed campaign response.

id · integer · required

name · string · required

start_parameter · string · required

bonus_type · enum<string> · required

Available options: balance, subscription, none, tariff

is_active · boolean · required

created_at · string<date-time> · required

balance_bonus_kopeks · integer · default: 0

balance_bonus_rubles · number · default: 0

subscription_duration_days · integer | null

subscription_traffic_gb · integer | null

subscription_device_limit · integer | null

subscription_squads · string[]

tariff_id · integer | null

tariff_duration_days · integer | null

tariff · TariffInfo · object

Tariff info for campaign.

Show child attributes

partner_user_id · integer | null

partner_name · string | null

created_by · integer | null

updated_at · string<date-time> | null

deep_link · string | null

web_link · string | null