Get Campaign Details API

The Get Campaign Details API can be used to fetch the products included in a specific Campaign.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Get Campaign Details Schema

PropertyTypeDescription
campaignIdIntUnique identifier of the campaign to fetch.

Response Schema

PropertyTypeDescription
dataobjectRoot response object.
data.campaignDetailsobjectContainer for campaign details.
data.campaignDetails.successnumberAPI execution status (1 = success).
data.campaignDetails.dataarrayList containing campaign detail entries.
data.campaignDetails.data[].campaignIdnumberUnique campaign ID.
data.campaignDetails.data[].campaignNamestringName of the campaign.
data.campaignDetails.data[].denomination_valuenumberDenomination/value associated with the campaign.
data.campaignDetails.data[].currency_codestringCurrency code for denomination.
data.campaignDetails.data[].countryNamestringApplicable country for the campaign.
data.campaignDetails.data[].vouchersarrayList of vouchers/products associated with this campaign.
data.campaignDetails.data[].vouchers[].namestringVoucher/product name.
data.campaignDetails.data[].vouchers[].imagestringImage URL for the voucher/product.
Body Params
string
required
Defaults to xoxo_link.mutation.campaignDetails
string
required
Defaults to xoxo_link
variables
object
required
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json