Skip to content
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
Cannot retrieve contributors at this time

REST API: GET emailing templates (Publisher)

You can use the REST API to retrieve all emailing templates for an account with an HTTP GET call to the following URL:

Available parameters

The following parameters are available for this call:

  • archived: Boolean that indicates whether to only include archived templates (true) or only templates that are not archived (false). Returns both by default.
  • modifiedfromdate: Date after which the templates should have been modified in YYYY-MM-DD HH:MM:SS format.
  • modifiedtodate: Date before which the templates should have been modified in YYYY-MM-DD HH:MM:SS format.

Returned fields

The method returns a JSON object where the *data field contains an array with emailing templates. Each template contains the following information:

  • id: The ID of the template.
  • name: The name of the template.
  • archived: The archive status of the template.

JSON example

The JSON for a single template will look something like this:


PHP example

The script below demonstrates how to use this API method.

// dependencies

// change this into your access token
$api = new CopernicaRestAPI("your-access-token", 3);

// parameters for the call (exclude archived templates)
$params = array(
    'archived'  => false

// execute the call
print_r($api->get("publisher/templates", $params));

This example requires the REST API class

More information