Skip to main content
GET
/
public
/
v1
/
campaign-service
/
json-templates
Get Json Templates
curl --request GET \
  --url https://api.topsort.com/public/v1/campaign-service/json-templates \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "jsonTemplates": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "jsonSchema": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "adFormat": "banner",
      "isArchived": false,
      "previewScreenshot": "<string>",
      "previewUrl": "<string>"
    }
  ],
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI.

Query Parameters

​
limit
integer
default:100

The pagination limit.

Required range: 0 <= x <= 100
​
next_page
string | null

A token provided in a previous response. If not empty, it is used to retrieve the page that follows.

​
search
string | null

Search query to filter the templates.

​
include_archived
boolean | null
default:false

Whether to include archived templates.

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.

​
jsonTemplates
JsonTemplate · object[]
required
​
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="