---
title: "List Sessions"
method: GET
path: "/print-mail/v1/template_editor_sessions"
tags: ["Template Editor Sessions"]
---

# List Sessions

`GET /print-mail/v1/template_editor_sessions`

Retrieve a paginated list of Template Editor Sessions.

## Query parameters

- `skip` integer
- `limit` integer
- `search` union
  - string
  - string — You can supply a structured search query instead of supplying unstructured text to any list endpoint help refine your search for a resource. For example, let's say you created a series of letters that all had `metadata: { campaignID: 'abc' }`. You could search for all those letters by passing in `{ "metadata.campaignID": "abc" }` into the `search` parameter. Note that this string must be valid JSON.

## Response `200`

A list object containing Template Editor Sessions.

- TemplateEditorSessionList
  - `object` 'list', required
  - `totalCount` integer, required
  - `skip` integer, required
  - `limit` integer, required
  - `data` TemplateEditorSession[], required
    - `id` string, required — A unique ID prefixed with `template_editor_session_`.
    - `object` 'template_editor_session', required — Always `template_editor_session`.
    - `live` boolean, required — `true` if this is a live mode session else `false`.
    - `template` string, required — ID of the underlying template that this edits.
    - `backURL` string, uri — The URL supplied when this editor session was created.
    - `title` string — The title supplied when this editor session was created.
    - `trackers` union — Controls which Trackers are displayed in the template editor session.
      - 'all' | 'none'
      - string[]
    - `styles` TemplateEditorSessionStyles — Style overrides for the template editor session.
      - `canvas` TemplateEditorSessionCanvasStyles — Style overrides for the template editor canvas.
        - `backgroundColor` string — The canvas background color.
      - `saveButton` TemplateEditorSessionSaveButtonStyles — Style overrides for the template editor save button.
        - `backgroundColor` string — The save button background color.
        - `textColor` string — The save button text color.
      - `panelText` TemplateEditorSessionPanelTextStyles — Style overrides for template editor panel text.
        - `color` string — The panel text color.
    - `url` string, uri, required — A URL that can be iframed or redirected to for editing the template.
    - `createdAt` string, date-time, required — The UTC time at which this session was created.

## Other responses

- `400` — A list object containing Template Editor Sessions.
- `401` — A list object containing Template Editor Sessions.
- `429` — A list object containing Template Editor Sessions.
- `500` — A list object containing Template Editor Sessions.

---

[API](https://skmtc.net/postgrid/apis/postgrid-print-mail-api.md) · [All operations](https://skmtc.net/postgrid/apis/postgrid-print-mail-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/postgrid/postgrid-print-mail-api/revisions/6bb9d268c5d1/schema)