Skip to main content
GET
/
public
/
v1
/
campaign-service
/
sponsored-products
Get Sponsored Products
curl --request GET \
  --url https://api.topsort.com/public/v1/campaign-service/sponsored-products \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "sponsoredProducts": [
    "<string>"
  ],
  "next": {
    "offset": 123,
    "limit": 123
  }
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Query Parameters

​
vendor_id
string
required

The ID of the vendor to get sponsored products.

​
offset
integer
default:0

The pagination offset.

Required range: x >= 0
​
limit
integer
default:100

The pagination limit.

Required range: 0 <= x <= 100
​
fetch_active_products
boolean
default:false

Whether to fetch only active products. If false, all products will be fetched even if the campaign or the bid are inactive.

Response

Successful Response

Paginated response for sponsored products in a vendor.

​
hasMore
boolean
required

Whether this is the last page of results or not.

​
sponsoredProducts
string[]
required

List of sponsored product ids.

​
next
Next · object

The parameters that should be used to fetch the next page.