List offers

get

https://api.sandbox.cleeng.com/3.1/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.

Additional response header: x-total-count. It will show the number of offers.

This endpoint supports conditional requests.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

pageNumber

string

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

pageLimit

string

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

string

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

type[]

array of strings

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

type[]

status

string

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

appStoreName

string

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.

appStoreProductId

string

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

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400