Skip to main content
POST
/
campaignList
cURL
curl --request POST \
  --url https://stagingstores.xoxoday.com/chef/v1/oauth/api \
  --header 'accept: application/json' \
  --header 'authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'content-type: application/json' \
  --data '{
    "query": "xoxo_link.query.campaignList",
    "tag": "xoxo_link",
    "variables": {
      "add_data": {
        "limit": 10,
        "offset": 0,
        "enabled": 1
      }
    }
  }'
{
  "data": {
    "campaignList": {
      "success": 1,
      "data": [
        {
          "campaignId": 2461,
          "campaignName": "Summer Rewards",
          "denomination_value": 10,
          "countryName": "USA",
          "currencyCode": "USD",
          "created_date": "2025-06-01 10:00:00",
          "product_count": 5,
          "status": 1
        }
      ]
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://help-plum.xoxoday.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Get Campaigns API Schema

PropertyTypeDescription
limitIntNumber of campaigns to fetch (pagination limit).
offsetIntStarting index for fetching campaigns (pagination offset).
nameStringFilter campaigns by name (optional, empty string means no filter).
enabledIntFilter by campaign status (1 = enabled, 0 = disabled).

​
Response Schema

PathTypeDescription
dataobjectRoot response object.
data.campaignListobjectContainer for campaign list.
data.campaignList.successnumberAPI execution status (1 = success).
data.campaignList.dataarrayList of campaigns.
data.campaignList.data[].campaignIdnumberUnique campaign identifier.
data.campaignList.data[].campaignNamestringName of the campaign.
data.campaignList.data[].denomination_valuenumberCampaign denomination or value associated with the campaign.
data.campaignList.data[].countryNamestringCountry where campaign is applicable.
data.campaignList.data[].currencyCodestringCurrency code for denomination.
data.campaignList.data[].created_datestringCreation timestamp of the campaign.
data.campaignList.data[].product_countnumberNumber of products linked to this campaign.
data.campaignList.data[].statusnumberStatus (1 = active, 0 = inactive).

Authorizations

​
Authorization
string
header
required

Authorization: Bearer <access_token>

Body

application/json
​
query
enum<string>
default:xoxo_link.query.campaignList
required

Always use xoxo_link.query.campaignList.

Available options:
xoxo_link.query.campaignList
​
tag
enum<string>
default:xoxo_link
required

Always use xoxo_link.

Available options:
xoxo_link
​
variables
object
required

Response

Campaign list returned successfully.

​
data
object