Search campaigns

get

https://api.vrio.app/campaigns

Search for specific campaign details and/or get all existing campaign details. A campaign is the container in which Offers being sold and payment router resides.

Query Params

campaign_id

integer

Search for specific Campaign ID(s). Comma separate for multiple.

campaign_name

string

Search for campaigns with a particular name.

route_id

integer

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.

merchant_id

integer

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.

shipping_profile_id

integer

Return campaigns that have a specific shipping profile ID available.

campaign_active

boolean

Return campaigns with a specific active status.

with

string

enum

Expand on the information returned by including 'with' in the query parameters. For multiple attributes, separate with a comma (example : with=offers,shipping_profiles)

Allowed:

limit

integer

Limit the number of results. Default: 25, max: 200.

offset

integer

Offset the results

sort_by

string

Field to sort result by

order

string

enum

Order by asc or desc

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

200OK

401Unauthorized response

403Forbidden response

500Error response