Skip to content

Latest commit



64 lines (45 loc) · 1.81 KB

File metadata and controls

64 lines (45 loc) · 1.81 KB

REST API: GET document (Publisher)

You can use the REST API to retrieve a summary of an emailing document with an HTTP GET call to the following URL:$id

Where $id should be replaced with the ID of the emailing document you want summarized.

Available parameters

This method supports the source parameter, which indicates whether the HTML source of the document should be retrieved or not. By default it is set to 'true', but the method can be executed faster by setting this to 'false'.

Returned fields

The method returns a JSON object containing the following information:

  • id: The ID of the document.
  • template: The ID of the corresponding template.
  • name: The name of the document.
  • from_address: The from address for the document.
  • subject: The subject of the document.
  • archived: The archive status of the document. (1 for archived, null for not archived)
  • source: The source of the document.

JSON example

The JSON for the document might look something like this:

   "from_address":"\"test\" <>",

PHP example

The script below demonstrates how to use this API method. Don't forget to replace the ID in the URL before executing the call.

// dependencies

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

// execute the call

This example requires the REST API class

More information