# List message templates

```http
GET https://secure.yoprint.com/v2/api/store/{team_slug}/setting/message_template
```

- API version: v2
- Operation ID: `v2_public_message_template_index`
- Section: Team settings › [Message templates](https://developer.yoprint.com/reference/message-templates.md)
- Web page: https://developer.yoprint.com/reference/message-templates/v2-message-template-index/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Returns all of the team's message templates: the system ones (the emails YoPrint sends for new sales orders, quotes and purchase orders) and the ones your team saved, with their raw subject and body, placeholders and attachments.

People pick saved templates when they message a customer or vendor from a sales order, quote or purchase order; system templates are used for the document emails.

| `type` | What it is | Placeholders |
| --- | --- | --- |
| `new_sales_order_message` | System: the "New Sales Order Detail" email | sales order |
| `new_quote_message` | System: the "New Quote Detail" email | quote |
| `purchase_order` | System: the "New Purchase Order Detail" email to a vendor | purchase order |
| `sales_order_message` | Your saved email for a sales order | sales order |
| `sales_order_text_message` | Your saved text message for a sales order | sales order |
| `quote_message` | Your saved email for a quote | quote |
| `quote_text_message` | Your saved text message for a quote | quote |
| `purchase_order_message` | Your saved email to a vendor about a purchase order | purchase order |
| `purchase_order_text_message` | Your saved text message to a vendor | purchase order |

## Permission

Any member of the team, whatever their role. This is wider than the web app, whose Settings pages need Manage Settings: on the API only changes need it.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.

## Request body

This operation takes no request body.

### Example request

```bash
curl 'https://secure.yoprint.com/v2/api/store/your-team/setting/message_template' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1'
```

## Response

`200` Successful response.

Fields:

- `data` (array of objects, required)
  - Each item:
    - `body` (string, required): Liquid: HTML for emails, plain text for text messages.
    - `can_create` (boolean, required)
    - `can_delete` (boolean, required)
    - `can_update` (boolean, required)
    - `created_at` (string (date-time), required)
    - `id` (string, required)
    - `internal_attachments` (array of objects, required): Its attachments, as the attachment operations return them.
      - Each item:
        - `created_at` (string (date-time), required)
        - `detail` (string | null, required): For a document attachment, defaults to its kind, such as `Sales Order/Quote (PDF)`.
        - `id` (string, required)
        - `media` (object | null, required): For a `media` or `reference_media` attachment, the file: `id`, `name`, `file_name`, `mime_type`, `size`, a download `url`, a signed `view_url` and more. Null for document attachments.
        - `media_id` (string | null, required)
        - `name` (string | null, required)
        - `options` (string | null, required): The attachment's options as a JSON-encoded string, not an object: `"[]"`, or for job sheets `"{\"show_mockup\":true}"`. `"null"` for a `media` or `reference_media` file. Decode it before use.
        - `order_id` (string | null, required)
        - `order_scoped_id` (string | integer | null, required)
        - `purchase_order_id` (string | null, required)
        - `purchase_order_scoped_id` (string | integer | null, required)
        - `type` (string, required)
        - `updated_at` (string (date-time), required)
    - `name` (string, required)
    - `subject` (string | null, required): Liquid, as saved; null when none was saved. Only the three system types use a subject (`support_subject: true`).
    - `support_attachments` (boolean, required): True for every type, text messages included.
    - `support_subject` (boolean, required): True for the three system types only. The six saved types have no subject line of their own.
    - `supported_attachments` (array of strings, required): The attachment `type` values this template can carry.
    - `supported_placeholder` (array of objects, required)
      - Each item:
        - `label` (string, required)
        - `value` (string, required): Write it in the template as `{{value}}`.
    - `system` (boolean, required): A system template: YoPrint's own email for new documents. It can be edited but not created or deleted.
    - `type` (string, required): One of: `"new_sales_order_message"`, `"new_quote_message"`, `"purchase_order"`, `"sales_order_message"`, `"sales_order_text_message"`, `"quote_message"`, `"quote_text_message"`, `"purchase_order_message"`, `"purchase_order_text_message"`.
    - `updated_at` (string (date-time), required)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": [
    {
      "body": "<p>Your order #{{order_number}} is ready for pickup at 100 Example Street.</p>",
      "can_create": true,
      "can_delete": true,
      "can_update": true,
      "created_at": "2026-10-01T09:00:00+00:00",
      "id": "DVubREua5aJkwh",
      "internal_attachments": [],
      "name": "Ready for pickup",
      "subject": null,
      "support_attachments": true,
      "support_subject": false,
      "supported_attachments": [
        "media",
        "reference_media",
        "order",
        "order_compact",
        "so_jobs_with_mockup",
        "so_jobs_without_mockup",
        "so_invoices",
        "so_compact_invoices"
      ],
      "supported_placeholder": [
        {
          "label": "Order Number",
          "value": "order_number"
        },
        {
          "label": "Customer Name",
          "value": "customer_name"
        }
      ],
      "system": false,
      "type": "sales_order_message",
      "updated_at": "2026-10-01T09:00:00+00:00"
    }
  ],
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.

## Related

- [Get a message template](https://developer.yoprint.com/reference/message-templates/v2-message-template-show.md): `GET /v2/api/store/{team_slug}/setting/message_template/{hash_id}`
- [Create a message template](https://developer.yoprint.com/reference/message-templates/v2-message-template-store.md): `POST /v2/api/store/{team_slug}/setting/message_template`
- [Send a template for a record](https://developer.yoprint.com/reference/message-templates/v2-message-template-send.md): `POST /v2/api/store/{team_slug}/setting/message_template/send`