v1
latestOpenAPI 3.0.12026-07-2412502.6 MBSearch campaigns
Search for specific campaign details and/or get all existing campaign details. A <a href='https://vrio.zendesk.com/hc/en-us/articles/14287607359639-Campaign-Overview' target='_blank'>campaign</a> is the container in which Offers being sold and payment router resides.
Query parameters
Search for specific Campaign ID(s). Comma separate for multiple.
Search for campaigns with a particular name.
Search for campaigns that are using a specific Route ID. This will return campaigns that are configured with the payment type as Router using the Route ID specified in the query.
Return campaigns that are using a specific Merchant ID. This will return campaigns that are configured with the payment type as Merchant using the Merchant ID specified in the query.
Return campaigns that have a specific shipping profile ID available.
Return campaigns with a specific active status.
Expand on the information returned by including 'with' in the query parameters. For multiple attributes, separate with a comma (example : with=offers,shipping_profiles)
Limit the number of results. Default: 25, max: 200.
Offset the results
Field to sort result by
Order by asc or desc
Response
OK
Example response
{
"campaigns": [
{
"date_created": "2023-04-01 00:00:00",
"date_modified": "2023-04-01 00:00:00"
}
]
}