/

Browse the help center

Get template by ID

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/template/edit.do

Returns the full details of a creative template including its metadata (title, placement type, active status, template type), the raw template content markup, the list of uploaded template files with checksums and content types, and all defined template properties with their configurations. The response also includes the caller's share type on the template (IS_OWNER, CAN_EDIT, or CAN_VIEW). Returns a notFound flag if the template does not exist. Requires VIEW permission on the template through ownership or sharing.

Query Params

id integer

ID of the template — omit on edit to create a new template; delete and export need it

12

active boolean

Whether the template is active

true

alwaysRedirect boolean

Whether the template always uses redirect mode for click tracking

false

content string

Template HTML/JS content body

<div>{{BANNER}}</div>

global boolean

Whether this is a global (system-wide) template

false

impressionRecordedByTemplate boolean

Whether impression tracking is handled by the template itself

false

maxRequiredNativeAdsAmount integer

Maximum number of native ads supported by this template

1

minRequiredNativeAdsAmount integer

Minimum number of native ads required by this template

1

placementType string

Placement type this template applies to

SITE_PLACEMENT

title string

Template title

Standard Banner 300x250

type string

Template type

GENERAL

Responses

200

Template details

400

Bad request — invalid or missing parameters

401

Authentication error

403

Insufficient permissions

404

Template not found

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/template/edit.do?id=12&placementType=SITE_PLACEMENT&type=GENERAL&active=true' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/template/edit.do?id=12&placementType=SITE_PLACEMENT&type=GENERAL&active=true", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/template/edit.do?id=12&placementType=SITE_PLACEMENT&type=GENERAL&active=true', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/template/edit.do?id=12&placementType=SITE_PLACEMENT&type=GENERAL&active=true"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("GET"), "https://YOUR-NETWORK-DOMAIN/rest-api/template/edit.do?id=12&placementType=SITE_PLACEMENT&type=GENERAL&active=true");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/template/edit.do?id=12&placementType=SITE_PLACEMENT&type=GENERAL&active=true", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/template/edit.do?id=12&placementType=SITE_PLACEMENT&type=GENERAL&active=true");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/template/edit.do?id=12&placementType=SITE_PLACEMENT&type=GENERAL&active=true")
request = Net::HTTP::Get.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body