Skip to main content
GET
/
public
/
v1
/
toppie
/
campaigns
[BETA] Get Toppie Campaigns
curl --request GET \
  --url https://api.topsort.com/public/v1/toppie/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "campaigns": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "adFormat": "banner",
      "chargeType": "CPM",
      "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "budget": 123,
      "budgetPeriod": "daily",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "targetRoas": 10.25,
      "currencyCode": "<string>",
      "isActive": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "bidCount": 123
    }
  ],
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}

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

​
next_page
string | null

Pagination cursor as provided in an earlier response. If provided will fetch the next page of results.

​
limit
integer
default:100

Limit of accounts to retrieve.

Required range: x <= 100

Response

Successful Response

​
hasMore
boolean
required

Flag that indicates whether more results are available. true indicates there is a next page of results. false indicates this response contains the last page of results.

​
campaigns
PublicAgencyCampaign · object[]
required

List of campaigns that belong to the agency

​
nextPage
string | null

Pagination cursor. Provide this value as a next_page query parameter in a new request to retrieve the next page of results.

Minimum string length: 1
Example:

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="