GET
/
v2
/
offsite-ads
/
campaigns
curl --request GET \
  --url https://api.topsort.com/v2/offsite-ads/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "campaigns": [
    {
      "budget": 123,
      "endDate": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "startDate": "2023-11-07T05:31:56Z",
      "status": "ENABLED"
    }
  ],
  "hasMore": true,
  "nextPage": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
dsps
enum<string>[]

Filter by DSPs.

Available options:
google_ads,
meta
​
status
enum<string>

Filter by campaign status.

Available options:
ENABLED,
PAUSED,
REMOVED
​
next_page
string

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

​
limit
integer
default:50

The maximum number of items to return per page.

Required range: 1 <= x <= 100

Response

200
application/json
Successful Response
​
campaigns
object[]
required

A list of campaigns.

​
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.

​
nextPage
string

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

Minimum length: 1