GET
/
campaigns
List Campaigns
curl --request GET \
  --url https://campaignservice.withbenji.com/campaigns \
  --header 'Authorization: Bearer <token>'
{
    "code": "ok",
    "data": {
        "campaign": {
            "base_reward": 1,
            "campaign_logo": "testcampaign.png",
            "campaign_type": 1,
            "created_date": "2024-11-20T00:30:57.256493+00:00",
            "description": "This is a test campaign",
            "end_date": null,
            "id": 1,
            "is_active": 1,
            "is_deleted": 0,
            "merchant_id": 1,
            "name": "Test Campaign",
            "owner_id": 5,
            "partner_id": 3,
            "start_date": "2024-11-14T03:18:06+00:00",
            "total_rewards": 100,
            "trigger_type": 1
        }
    }
}
The Bearer token to be used on this API is your partner access token
​
campaign_types
string
required

Comma separated list of possible campaign type values :

​
Return values

​
campaigns
array

An Array of campaign objects associated with your account

{
    "code": "ok",
    "data": {
        "campaign": {
            "base_reward": 1,
            "campaign_logo": "testcampaign.png",
            "campaign_type": 1,
            "created_date": "2024-11-20T00:30:57.256493+00:00",
            "description": "This is a test campaign",
            "end_date": null,
            "id": 1,
            "is_active": 1,
            "is_deleted": 0,
            "merchant_id": 1,
            "name": "Test Campaign",
            "owner_id": 5,
            "partner_id": 3,
            "start_date": "2024-11-14T03:18:06+00:00",
            "total_rewards": 100,
            "trigger_type": 1
        }
    }
}
Note that you will only receive data that you as a loyalty patner or merchant partner are allowed to see based on the permissions in the access token you provide to the API