Get Scope Options

Return lightweight lists of campaigns and partners for the scope selector.

GET /cabinet/admin/referral-network/scope-options

Get Scope Options

cURL

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

200

{
  "campaigns": [
    {
      "id": 123,
      "name": "<string>",
      "start_parameter": "<string>",
      "is_active": true,
      "direct_users": 123
    }
  ],
  "partners": [
    {
      "id": 123,
      "display_name": "<string>",
      "username": "<string>",
      "campaign_count": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Response

200 - application/json

Successful Response

campaigns · CampaignOption · object[] · required

Show child attributes

partners · PartnerOption · object[] · required

Show child attributes