Sign in
Design Studio

List emails

Returns a paginated list of emails and a separate array of folders that the emails belong to.

get/v1/design_studio/emails

Query parameters

pageinteger

The page number of results you want to display. Use with limit.

limitinteger

Limit the number of results per page.

parent_folder_idstring uuid

Filter by parent folder. Must reference an existing folder. If not set, the response filters by the root level directory.

To list only items in the root folder, leave parent_folder_id unset and only set direct_descendants_only to true.

direct_descendants_onlyboolean

If true, this returns only children of the parent folder.

sort_by'created' | 'updated' | 'name'
sort_order'asc' | 'desc'
created_beforeinteger

Return records created before this time. Must be a unix timestamp.

created_afterinteger

Return records created after this time. Must be a unix timestamp.

updated_beforeinteger

Return records updated before this time. Must be a unix timestamp.

updated_afterinteger

Return records updated after this time. Must be a unix timestamp.

is_template'true' | 'false' | 'any'

Filter by whether the email is a template

has_translations'true' | 'false' | 'any'

Filter by whether the email has translations

is_linked'true' | 'false' | 'any'

Filter by whether the email is linked to a workflow (automation, broadcast, etc).

Response

Successful response

Example response

{
  "emails": [
    {
      "id": "sdflkj345",
      "parent_folder_id": "123e4567-e89b-12d3-a456-426614174000",
      "created": 1714732800,
      "updated": 1714732800
    }
  ],
  "folders": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Product Announcements",
      "parent_folder_id": null,
      "created": 1714732800,
      "updated": 1714732800
    }
  ],
  "meta": {
    "filters": {
      "parent_folder_id": "123e4567-e89b-12d3-a456-426614174000",
      "direct_descendants_only": true,
      "sort_by": "created",
      "sort_order": "desc",
      "created_before": 1714732800,
      "created_after": null,
      "updated_before": null,
      "updated_after": null
    }
  }
}

Changes

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