Emails

Retrieve all emails

get

Retrieve all of a workspace's template emails.

Responses

200

A collection of emails.

application/json

idstringRequired

The ID of the email.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c

namestringRequired

The email's name.

Example: Welcome Email

contentobjectRequired

The email's content.

subject_linestringRequired

The email's subject line.

Example: Hello world!

preview_linestringRequired

The email's preview line.

Example: Hello world!

created_atstring · date-timeRequired

Timestamp of when the email was created.

Example: 2025-01-01T00:00:00.000Z

updated_atstring · date-timeRequired

Timestamp of when the email was last updated.

Example: 2025-01-01T00:00:00.000Z

401

The user is not authenticated.

403

The user does not have permission to perform this operation.

get/emails

GET /api/v1/emails HTTP/1.1
Accept: */*

[
  {
    "id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
    "name": "Welcome Email",
    "content": {},
    "subject_line": "Hello world!",
    "preview_line": "Hello world!",
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z"
  }
]

Retrieve an email

get

Retrieve an email by ID.

Responses

200

An email.

application/json

idstringRequired

The ID of the email.

Example: 981ba079-62a6-442c-8dfb-a72af6e96b8c

namestringRequired

The email's name.

Example: Welcome Email

contentobjectRequired

The email's content.

subject_linestringRequired

The email's subject line.

Example: Hello world!

preview_linestringRequired

The email's preview line.

Example: Hello world!

created_atstring · date-timeRequired

Timestamp of when the email was created.

Example: 2025-01-01T00:00:00.000Z

updated_atstring · date-timeRequired

Timestamp of when the email was last updated.

Example: 2025-01-01T00:00:00.000Z

401

The user is not authenticated.

403

The user does not have permission to perform this operation.

get/emails/{emailId}

GET /api/v1/emails/{emailId} HTTP/1.1
Accept: */*

{
  "id": "981ba079-62a6-442c-8dfb-a72af6e96b8c",
  "name": "Welcome Email",
  "content": {},
  "subject_line": "Hello world!",
  "preview_line": "Hello world!",
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z"
}