List the public template library

Reference

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

Lists the templates of Epom's public template library - rich-media and adapter formats such as catfish, interstitial, skin, video slider - each with what it does, its placement type, its properties and whether this network already has it: AVAILABLE (not installed), INSTALLED (installedTemplateId is yours to use), UPDATE_AVAILABLE (installed, the library has a newer build) or NOT_SHARED (installed, but not shared with you). An AVAILABLE template that has an active template of the same name in the account lists it in sameNameTemplateIds (a copy made by hand). Each template also carries devices (desktop, mobile or both), lastChanged (the date its source last changed, when known), readmeUrl (its README: what it does, its settings, gotchas) and previewUrls (desktop / mobile screenshots, when it has them). Requires the Templates create permission and the Templates view permission on all templates (the library reports what the whole network holds).

Query Params

query string

Words that must all appear in a template's name, format, description, devices or placement type, e.g. "catfish mobile"

catfish

placementType string

Only templates for this placement type

MOBILE_SITE_PLACEMENT

Responses

200

The library's templates with their status on this network

400

Bad request — invalid or missing parameters

401

Authentication error

403

No Templates create permission, or Templates view is not granted on all templates

503

The template library is not set up on this network or could not be read

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/template-catalog/list.do?placementType=MOBILE_SITE_PLACEMENT&query=catfish' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/template-catalog/list.do?placementType=MOBILE_SITE_PLACEMENT&query=catfish", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/template-catalog/list.do?placementType=MOBILE_SITE_PLACEMENT&query=catfish', {
  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-catalog/list.do?placementType=MOBILE_SITE_PLACEMENT&query=catfish"))
    .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-catalog/list.do?placementType=MOBILE_SITE_PLACEMENT&query=catfish");
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-catalog/list.do?placementType=MOBILE_SITE_PLACEMENT&query=catfish", 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-catalog/list.do?placementType=MOBILE_SITE_PLACEMENT&query=catfish");
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-catalog/list.do?placementType=MOBILE_SITE_PLACEMENT&query=catfish")
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