Search offers

 

Query Params
string

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

string

Search for offers by the offer name.

integer
enum

Search for specific types of offers.

  • 1 - One Time Sale
  • 2 - Recurring
Allowed:
integer

Filter results using the Primary Category ID configured when setting up an offer. This value can be found on the Offer Category page in Vrio.

integer

Filter results using the Secondary Category ID configured when setting up an offer. This value can be found on the Offer Category page in Vrio.

integer

Search for offers that use a specific dunning schedule.

integer

Search for offers by the In Cart upsell profile.

integer

Search for offers by the Post Cart upsell profile.

integer

Search for offers by the Recurring upsell profile.

integer

Search for offers that belong to a specific connection.

integer

Search for offers that are associated with a specific campaign.

boolean

Return offers with a specific active status.

string
enum

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

Allowed:
integer

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

integer

Offset the results

string

Field to sort result by

string
enum

Order by asc or desc

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json