Skip to content
Documentation

Get Email Comments

GET
/api/v1/workspaces/{workspace_id}/emails/{email_id}/email_comments

Retrieves the email comments.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace_id
required
integer

Workspace ID

email_id
required
integer

Email ID

Query Parameters

Section titled “Query Parameters ”
locale
required
string

Locale

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful

object
results
required
Array<object>
object
id
required
integer
Example
12345
email_id
required
integer
Example
12345
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
author_type
string
Allowed values: User AiReviewer
author
required
One of:
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
parent_id
required
integer
nullable
Example
12345
pin_data
required
object
id
required
string
Example
12345
component_instance_id
string
Example
12345
branch_key
string
Example
a_branch_key
coordinates
required
object
center_offset_x_px
required
number
Example
0.5
y
required
number
Example
0.5
body
required
string
Example
This is a comment
resolved
required
boolean
resolver_id
required
integer
nullable
Example
12345
resolver
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
created_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z

401

Section titled “401 ”

Unauthorized

object
message
required
string
Example
Record not found

403

Section titled “403 ”

Forbidden

object
message
required
string
Example
Record not found