Sign in
Email Template

List email templates

Retrieve all email template objects.

get/api/v1/email_templates

Query parameters

page_sizeinteger

Number of results per page

cursorstring

A value used for cursor-based pagination. Obtain this value from the next or previous URLs in a paginated response. Do not construct cursor values manually.

idinteger[]

Object ID(s) filter

queueinteger[]

Queue ID(s) filter

type'rejection' | 'rejection_default' | 'email_with_no_processable_attachments' | 'custom'

Type of the email template to filter by

namestring

Object name filter

ordering'id' | '-id' | 'name' | '-name'

Result ordering.

Response

OK

Example response

{
  "results": [
    {
      "id": 1234,
      "url": "https://example.rossum.app/api/v1/email_templates/789",
      "name": "My Email Template",
      "queue": "https://example.rossum.app/api/v1/queues/8198",
      "organization": "https://example.rossum.app/api/v1/organizations/406",
      "triggers": [
        "https://example.rossum.app/api/v1/triggers/500",
        "https://example.rossum.app/api/v1/triggers/600"
      ],
      "type": "custom",
      "subject": "My Email Template Subject",
      "message": "<p>My Email Template Message</p>",
      "enabled": true,
      "automate": true,
      "to": [
        {
          "email": "recipient@example.com",
          "name": "Recipient Name"
        }
      ],
      "cc": [],
      "bcc": [],
      "modified_by": "https://example.rossum.app/api/v1/users/10775",
      "modified_at": "2021-04-26T10:08:03.856648Z"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.