API Reference

Lists offers across networks matching the supplied filter.

get
https://platform.routy.app/api/v1/partners/offers

Requires the ListNetworks policy and the partners feature.
Paginate with offset (0-based) and limit. Filter by ids, network/partner/traffic-source,
country/region/currency codes, visibility (Public or Partners) and free-text term.
Set my=true to return only offers owned by the requesting partner; my=false returns
only offers whose visibility is Public or Partners.

🔐 Required permission: networks.read

🚩 Requires feature: partners

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
Id
array of int32s

Optional list of offer ids to restrict the result to.

Id
AffiliateId
array of int32s

affiliate of network

AffiliateId
PartnerAffiliateId
array of int32s

Optional list of partner affiliate ids to filter by.

PartnerAffiliateId
TrafficSourceId
array of int32s

Optional list of traffic source ids to filter by.

TrafficSourceId
NetworkId
array of int32s

Optional list of network ids to filter by.

NetworkId
PartnerId
array of int32s

Optional list of partner ids to filter by.

PartnerId
BrandLinkId
array of int32s

Optional list of brand link ids to filter by.

BrandLinkId
CountryCodes
array of strings

Optional list of ISO country codes to filter by.

CountryCodes
RegionCode
array of strings

Optional list of region codes to filter by.

RegionCode
CurrencyCode
array of strings

Optional list of currency codes to filter by.

CurrencyCode
string
enum

Optional visibility filter: Public or Partners.

Allowed:
boolean

if true, only offers that belong to the partner making the request
if false, only offers that are Platform.Models.Network.Partners.Offers.OfferVisibility.Public or Platform.Models.Network.Partners.Offers.OfferVisibility.Partners

string

Optional free-text search term matched against the offer name.

string

Optional sort expression (column name).

int32

0-based number of rows to skip (pagination offset).

int32

Maximum number of offers to return.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 2 days ago

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

Updated 2 days ago