List Sessions

GET/print-mail/v1/template_editor_sessions

Retrieve a paginated list of Template Editor Sessions.

Query ParametersExpand Collapse

limit: optional number

formatint32

search: optional string

You can supply any string to help narrow down the list of resources. For example, if you pass "New York" (quoted), it will return resources that have that string present somewhere in their response. Alternatively, you can supply a structured search query. See the documentation on StructuredSearchQuery for more details.

skip: optional number

formatint32

ReturnsExpand Collapse

data: array of object { id, createdAt, live, 7 more }

id: string

A unique ID prefixed with template_editor_session_.

createdAt: string

The UTC time at which this session was created.

formatdate-time

live: boolean

true if this is a live mode session else false.

object: "template_editor_session"

Always template_editor_session.

template: string

ID of the underlying template that this edits.

url: string

A URL that can be iframed or redirected to for editing the template.

formaturi

backURL: optional string

The URL supplied when this editor session was created.

formaturi

styles: optional object { canvas, panelText, saveButton }

Style overrides for the template editor session.

canvas: optional object { backgroundColor }

Style overrides for the template editor canvas.

backgroundColor: optional string

The canvas background color.

panelText: optional object { color }

Style overrides for template editor panel text.

color: optional string

The panel text color.

saveButton: optional object { backgroundColor, textColor }

Style overrides for the template editor save button.

backgroundColor: optional string

The save button background color.

textColor: optional string

The save button text color.

title: optional string

The title supplied when this editor session was created.

trackers: optional "all" or "none" or array of string

Controls which Trackers are displayed in the template editor session.

One of the following:

"all" or "none"

One of the following:

"all"

"none"

array of string

limit: number

formatint32

object: "list"

skip: number

formatint32

totalCount: number

formatint32

List Sessions

curl https://api.postgrid.com/print-mail/v1/template_editor_sessions \
    -H "X-API-Key: $POSTGRID_PRINT_MAIL_API_KEY"

{
  "object": "list",
  "limit": 10,
  "skip": 0,
  "totalCount": 1,
  "data": [
    {
      "id": "template_editor_session_bBYRQ5DKu3LJ5yNemoAQ7E3or6E7Yzd7FGNWJSXBRrAfcdoNXNGLvfZxAm2dJYiv9c",
      "object": "template_editor_session",
      "live": false,
      "template": "template_eYxcbMKPZEZPk71ZJPA6Yz",
      "backURL": "https://postgrid.com",
      "title": "My Editor Session",
      "trackers": "none",
      "url": "https://dashboard.postgrid.com/embed/template_editor_sessions/template_editor_session_bBYRQ5DKu3LJ5yNemoAQ7E3or6E7Yzd7FGNWJSXBRrAfcdoNXNGLvfZxAm2dJYiv9c",
      "createdAt": "2023-07-05T19:36:01.369Z"
    }
  ]
}

Returns Examples

{
  "object": "list",
  "limit": 10,
  "skip": 0,
  "totalCount": 1,
  "data": [
    {
      "id": "template_editor_session_bBYRQ5DKu3LJ5yNemoAQ7E3or6E7Yzd7FGNWJSXBRrAfcdoNXNGLvfZxAm2dJYiv9c",
      "object": "template_editor_session",
      "live": false,
      "template": "template_eYxcbMKPZEZPk71ZJPA6Yz",
      "backURL": "https://postgrid.com",
      "title": "My Editor Session",
      "trackers": "none",
      "url": "https://dashboard.postgrid.com/embed/template_editor_sessions/template_editor_session_bBYRQ5DKu3LJ5yNemoAQ7E3or6E7Yzd7FGNWJSXBRrAfcdoNXNGLvfZxAm2dJYiv9c",
      "createdAt": "2023-07-05T19:36:01.369Z"
    }
  ]
}