v1

latestOpenAPI 3.1.02026-07-241080412.6 KB

List offers

This endpoint lets you list all your offers that meet the requirements given in the API request. For example, it allows you to filter offers by offer type or offer status. <br /><br /> Additional response header: x-total-count. It will show the number of offers. <br /><br /> This endpoint supports conditional requests.

get/offers

Query parameters

pageNumberstring

Pagination parameter. It indicates the page number. By default, this parameter is equal to 1.

pageLimitstring

Pagination parameter. It indicates the number of items on a page. By default, 15 results per page are returned.

searchstring

A search key. The endpoint should search by title and offerId (including the main offer and offer localizations).

type[]string[]

Filters results by offer type (subscription, pass, vod, live).

statusstring

Filters results by offer status (active, inactive, all). By default all offers are listed.

appStoreNamestring

Filters results by one of the allowed values: amazon, android, apple, roku, samsung, vizio. This parameter must be used together with the appStoreProductId. It cannot be used alone.

appStoreProductIdstring

Filters results by third party id. This parameter must be used together with the appStoreName. It cannot be used alone..

Response

200