API Documentation
Tokens
Member API
- Users
Campaign API
- Campaigns
- CampaignTemplates
- Triggers
Reward API
- Transactions
Webhooks
Campaigns
List all campaigns
GET
/
campaigns
curl --request GET \
--url https://campaignservice-staging.withbenji.com/campaigns \
--header 'Authorization: Bearer <token>'
{
"campaigns": [
{
"id": 1,
"name": "<string>",
"description": "<string>",
"campaign_logo": "<string>",
"campaign_type": 1,
"trigger_type": 1,
"custom_trigger_id": 123,
"partner_id": 1,
"merchant_id": 1,
"partnership_id": 1,
"is_active": 0,
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"owner_id": 1,
"is_template": 0,
"template_id": 123,
"total_rewards": 1,
"actions": [
{
"id": null,
"action_type": 1,
"partner_id": 2,
"base_reward": 1
}
],
"conditions": [
{
"id": null,
"partner_id": 2,
"campaign_condition_type": 1,
"condition_value": 1,
"condition_operator": 1,
"or_and_operator": 1,
"condition_attribute": 123
}
],
"multipliers": [
{
"id": null,
"partner_id": 123,
"multiplier_attribute_type": 1,
"multiplier_amount": 1,
"multiplier_attribute": 2
}
],
"goals": [
{
"id": null,
"partner_id": 2,
"goal_type": 1,
"goal_value": null,
"goal_operator": 1
}
]
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Response
200
application/json
OK
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://campaignservice-staging.withbenji.com/campaigns \
--header 'Authorization: Bearer <token>'
{
"campaigns": [
{
"id": 1,
"name": "<string>",
"description": "<string>",
"campaign_logo": "<string>",
"campaign_type": 1,
"trigger_type": 1,
"custom_trigger_id": 123,
"partner_id": 1,
"merchant_id": 1,
"partnership_id": 1,
"is_active": 0,
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"owner_id": 1,
"is_template": 0,
"template_id": 123,
"total_rewards": 1,
"actions": [
{
"id": null,
"action_type": 1,
"partner_id": 2,
"base_reward": 1
}
],
"conditions": [
{
"id": null,
"partner_id": 2,
"campaign_condition_type": 1,
"condition_value": 1,
"condition_operator": 1,
"or_and_operator": 1,
"condition_attribute": 123
}
],
"multipliers": [
{
"id": null,
"partner_id": 123,
"multiplier_attribute_type": 1,
"multiplier_amount": 1,
"multiplier_attribute": 2
}
],
"goals": [
{
"id": null,
"partner_id": 2,
"goal_type": 1,
"goal_value": null,
"goal_operator": 1
}
]
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.