Skip to main content
GET
/
campaigns
/
{id}
Get a single campaign
curl --request GET \
  --url https://campaignservice-staging.withbenji.com/campaigns/{id} \
  --header 'Authorization: Bearer <token>'
{
  "campaign": {
    "id": 1,
    "name": "<string>",
    "description": "<string>",
    "campaign_logo": "<string>",
    "campaign_type": 1,
    "merchant_id": 2,
    "partner_id": 2,
    "partnership_id": 2,
    "is_active": 0,
    "is_deleted": 0,
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "activation_date": "2023-11-07T05:31:56Z",
    "owner_id": 1,
    "is_template": 0,
    "template_id": 123,
    "total_rewards": 1,
    "campaign_flows": [
      {
        "id": 1,
        "campaign_id": 2,
        "trigger_type": 1,
        "custom_trigger_id": 123,
        "is_active": 0,
        "is_deleted": 0,
        "created_date": "2023-11-07T05:31:56Z",
        "actions": [
          {
            "id": 0,
            "action_type": 1,
            "partner_id": 2,
            "base_reward": 1,
            "extra_data": {}
          }
        ],
        "conditions": [
          {
            "id": 0,
            "partner_id": 2,
            "campaign_condition_type": 1,
            "condition_attribute": 123,
            "condition_value": "<any>",
            "condition_operator": 1,
            "or_and_operator": 1
          }
        ],
        "multipliers": [
          {
            "id": 0,
            "partner_id": 2,
            "multiplier_attribute_type": 1,
            "multiplier_attribute": 123,
            "multiplier_value": 123,
            "multiplier_amount": 1
          }
        ]
      }
    ],
    "goals": [
      {
        "id": 0,
        "partner_id": 2,
        "goal_type": 1,
        "goal_value": 1,
        "goal_operator": 1
      }
    ],
    "created_date": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

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

Response

OK

campaign
object
required

The campaign object containing all campaign details including its configuration, reward structure, eligibility criteria, and performance metrics. This is the primary data structure returned when retrieving a specific campaign.