Skip to content
Documentation

Get Email

GET
/api/v1/workspaces/{workspace_id}/emails/{id}

Retrieves an email by ID.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace_id
required
integer

Workspace ID

id
required
integer

Email ID

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful

object
id
required
integer
Example
12345
status
required
string
Allowed values: draft in_review changes_requested approved published
name
required
string
Example
My Email
project_id
required
integer
Example
12345
created_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
organization_id
required
integer
Example
12345
email_design_system_id
required
integer
Example
12345
email_content
required
object
subject
required
object
conditional_id
integer
branch_content
required
object
key
additional properties

Localized email subject, keyed by BCP47 locale

object
key
additional properties
string
Example
My Email Subject in a Specific Locale
preheader
required
object
conditional_id
integer
branch_content
required
object
key
additional properties

Localized email preheader, keyed by BCP47 locale

object
key
additional properties
string
Example
My Email Preheader in a Specific Locale
container_component_instance
required
object
id
required
string
Example
bd1c1b82-1a7b-4f0f-b079-30c1d4189bed
name
string
Example
My Component
component_id
required
integer
conditional_id
integer
field_values
object
key
additional properties
object
key
additional properties
object
key
additional properties
object
value
required
One of:
string
link_tracking_parameters
object
key
additional properties
string
hidden_from_locales
object
key
additional properties
boolean
Example
true
component_instances
required
Array<object>
object
id
required
string
Example
bd1c1b82-1a7b-4f0f-b079-30c1d4189bed
name
string
Example
My Component
component_id
required
integer
conditional_id
integer
field_values
object
key
additional properties
object
key
additional properties
object
key
additional properties
object
value
required
One of:
string
link_tracking_parameters
object
key
additional properties
string
hidden_from_locales
object
key
additional properties
boolean
Example
true
global_link_tracking_parameters
object
key
additional properties
string
default_locale
required
string
Allowed values: ar-SA bn-BD bn-IN ca-ES cs-CZ da-DK de-AT de-CH de-DE el-GR en-AU en-CA en-GB en-IE en-IN en-NZ en-US en-ZA es-AR es-CL es-CO es-ES es-MX es-US fi-FI fr-BE fr-CA fr-CH fr-FR he-IL hi-IN hu-HU id-ID it-CH it-IT ja-JP ko-KR nl-BE nl-NL no-NO pl-PL pt-BR pt-PT ro-RO ru-RU sk-SK sv-SE ta-IN ta-LK th-TH tr-TR zh-CN zh-HK
Example
en-US
locales
required
Array<string>
Allowed values: ar-SA bn-BD bn-IN ca-ES cs-CZ da-DK de-AT de-CH de-DE el-GR en-AU en-CA en-GB en-IE en-IN en-NZ en-US en-ZA es-AR es-CL es-CO es-ES es-MX es-US fi-FI fr-BE fr-CA fr-CH fr-FR he-IL hi-IN hu-HU id-ID it-CH it-IT ja-JP ko-KR nl-BE nl-NL no-NO pl-PL pt-BR pt-PT ro-RO ru-RU sk-SK sv-SE ta-IN ta-LK th-TH tr-TR zh-CN zh-HK
updated_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
last_updated_by
required
object
id
required
integer
Example
12345
first_name
required
string
Example
John
last_name
required
string
Example
Smith
profile_image_url
required
string
nullable
Example
https://example.com/profile.jpg
create_with_ai
required
boolean
nullable
prompt
required
string
nullable
Example
Write a welcome email to a new customer
ai_generation_status
required
string
nullable
Allowed values: generating done
Example
generating
ai_agent_id
required
integer
nullable
Example
12345
brand_profile_id
required
integer
nullable
Example
12345
link_tracking_profile_id
required
integer
nullable
Example
12345