List messages by view

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Returns messages in the shared mailbox filtered by the specified view. Use 'all' for the full inbox, 'unread' for unread messages, 'unassigned' for messages with no assignee, 'assigned' for messages with an assignee, 'archived' for archived messages, 'spam' for spam, and 'trash' for trashed messages. Results are paginated; use pageToken from the response to fetch the next page.

Request URL

https://mail.zoho.com/api/v2/sharedmailbox/{mailboxIdentifier}/messages/{view} Copied!

Note:

Use the request URL with the domain that matches the DC where your account is hosted. Refer Multiple data centers section for data center information.

Scope

ZohoMail.messages.READCopied!
(or)
ZohoMail.messages.ALLCopied!

Request Parameters

- Path Parameters

mailboxIdentifierstringMandatory

Email address or numeric zgid (group ID) of the shared mailbox group.

Example
support@zylker.com
Maximum Length :256Copied!
viewstringMandatory

View to list messages from. 'all': all messages; 'unread': unread only; 'unassigned': no assignee; 'assigned': has an assignee; 'archived': archived; 'spam': spam; 'trash': trashed.

Example
all
Allowed Values :
Show Values ▾
allCopied!
unreadCopied!
unassignedCopied!
assignedCopied!
archivedCopied!
spamCopied!
trashCopied!
Copied!Copy all as JSON Array

- Query Parameters

startintegerOptional

0-based index of the first message to return. Minimum 0. Defaults to 0.

Example
0
limitintegerOptional

Maximum number of messages to return per page. Range: 1 to 200. Defaults to 10.

Example
10
isPrevbooleanOptional

When true, fetches the previous page relative to the current position. Defaults to false.

Example
false
lastModifiedTimestringOptional

Epoch milliseconds as a string (long as string). When set to a positive value, returns only messages modified after this timestamp. Pass '-1' (default) to disable filtering.

Example
1746172800000
pageTokenstringOptional

Opaque pagination cursor returned by a previous response. Pass this value to fetch the next or previous page of results.

Example
eyJzdGFydCI6MTAsImxpbWl0IjoxMH0
Maximum Length :50000Copied!
fieldsstringOptional

Comma-separated fields to include in response. When omitted, all fields are returned. Possible values: messageId, mailSpaceId, entityId, entityType, messageVia, senderId, senderName, latestSenderName, groupId, groupName, isGroup, streamsEnabled, content, title, summary, htmlSummary, fromAddress, toAddress, ccAddress, messageType, isConversation, lastReplyUserId, lastMessageId, sentOnly, folderDetails, displayImage, entitySize, threadId, threadEntities, threadUnreadCount, threadCount, conversationThreadId, timestamps, createdAt, lastModifiedAt, displayDate, displayTime, updatedTime, pinnedTime, draftSentTime, toTimezone, archived, draft, lockInvites, pinned, liked, spam, trash, unread, starred, watching, shared, autoShare, hasAttachments, isOwner, ownerId, accessLevel, accessLevelVsInvitees, subSpaceId, collectionSpace, allowComments, showInvite and other fields also. Default: messageId,title,fromAddress,toAddress,createdAt,unread,senderId,senderName,commentsCount,tags.

Example
messageId,title,fromAddress,toAddress,createdAt,unread
Maximum Length :1000Copied!

Sample Request

Curl
Java
Python
Deluge
Php
Copied!
curl --request GET \
  --url 'https://mail.zoho.com/api/v2/sharedmailbox/support@zylker.com/messages/all?start=0&limit=10&isPrev=false&lastModifiedTime=1746172800000&pageToken=eyJzdGFydCI6MTAsImxpbWl0IjoxMH0&fields=messageId%2Ctitle%2CfromAddress%2CtoAddress%2CcreatedAt%2Cunread' \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object

Response envelope for list-messages operations.

Show Sub-Attributes
dataJSON Object

Messages and optional pagination tokens.

Show Sub-Attributes
userInfoJSON Object

Map of ZUID to display name for users referenced in the message list. Present when the streams new-flow flag is enabled.

Show Sub-Attributes
{key_name}string
Accepts any additional properties with custom keys
nextPageTokenstring

Opaque token to retrieve the next page. Absent when there are no more results. Pass as pageToken query parameter.

messagesJSON Array

List of messages for the requested view. Each message is a nested object with message, sender, group, timestamps, state, ownership, permissions, activity, comments, thread, labels, and relationships sub-objects.

Show Sub-Attributes
JSON Object

A shared mailbox message as returned in list views. Fields are grouped into nested objects matching the API response structure.

Show Sub-Attributes
integrationInfosJSON Array[object]

Integration metadata linked to the message (e.g. associated Zoho CRM deals, Desk tickets). Present when the message has associated integrations.

Show Sub-Attributes
generateViewboolean

Whether to generate a view for this integration. Present in migration context only.

idstring

ID of the integrated entity (long as string).

timestring

Timestamp of the integration event (long as string).

typestring

Integration relation type name (e.g. 'CRM', 'DESK').

titlestring

Display title from the integrated source.

infostring

Additional metadata from the integrated source.

commentsJSON Object

Comment section for the message. In list views contains only totalComments; in detail view also contains commentItems and optionally privateToPostComments.

Show Sub-Attributes
totalCommentsinteger

Total number of comments on the message.

nextPageTokenstring

Opaque token to fetch the next page of comments. Present when more comments exist.

commentItemsJSON Array

Full comment objects. Present when includeComment=true is requested.

Show Sub-Attributes
JSON Object

A comment on a shared mailbox message as returned by getCommentJSONV2. Fields are grouped into nested objects.

Show Sub-Attributes
integrationInfosJSON Object

Integration metadata linked to the comment. Present when the comment was created via a Zoho integration.

Show Sub-Attributes
idstring

ID of the integrated entity (long as string).

timestring

Timestamp of the integration event (long as string).

typestring

Integration relation type (e.g. 'CRM', 'DESK').

titlestring

Display title from the integrated source.

infostring

Additional metadata from the integrated source.

privateJSON Object

Private replies on this comment. Present when includePrivateComments=true and private replies exist.

Show Sub-Attributes
privateCommentsJSON Array

List of private replies on this comment.

Show Sub-Attributes
JSON Object

A private comment visible only to the sender and one recipient, as returned by buildPrivateCommentJSON.

Show Sub-Attributes
createdAtstring

ISO 8601 creation time of the private comment.

integrationInfosJSON Object

Integration metadata linked to the private comment. Present when the comment has integration data.

Show Sub-Attributes
idstring

ID of the integrated entity (long as string).

timestring

Timestamp of the integration event (long as string).

typestring

Integration relation type (e.g. 'CRM', 'DESK').

titlestring

Display title from the integrated source.

infostring

Additional metadata from the integrated source.

commentAuthorJSON Object

Author of the private comment.

Show Sub-Attributes
authorNamestring

Display name of the author.

authorIdstring

Numeric user ID of the author (long as string).

recipientstring

Numeric user ID of the intended recipient (long as string).

commentIdstring

Unique numeric ID of the private comment (long as string).

isPrivatestring

Always 'true' for private comments.

messageViastring

Always 'REST' for private comments created via API.

contentJSON Object

Content of the private comment.

Show Sub-Attributes
RTFboolean

True when the content is rich text.

RTFTextstring

Raw rich-text (HTML) content. Present when RTF is true.

textstring

Plain-text content.

RTFText_sanitizedboolean

True when RTFText has been sanitized.

activityJSON Object

Social activity and metadata on the comment.

Show Sub-Attributes
remindersarray[string]

Reminder IDs associated with the comment (long as string each). Present when reminders exist.

likesCountinteger

Number of likes on the comment.

likedByarray[string]

Numeric user IDs of users who liked the comment (long as string each). Present when likesCount > 0.

tagsJSON Array[object]

Inline quote tags within the comment text, as offset markers into the comment content.

Show Sub-Attributes
frominteger

Start character offset within the text.

tointeger

End character offset within the text.

textstring

The tagged span of text.

typestring

Tag kind. One of: MENTION, HASHTAG, QUOTE, TWEET_MENTION, LINK.

Allowed Values :
Show Values ▾
MENTIONCopied!
HASHTAGCopied!
QUOTECopied!
TWEET_MENTIONCopied!
LINKCopied!
Copied!Copy all as JSON Array
commentReplyJSON Object

Reply-to context when the comment is a threaded reply to another comment. Present only when replyTo is set.

Show Sub-Attributes
replyToDisplayNamestring

Display name of the parent comment's author.

replyTostring

Comment ID of the parent comment being replied to.

replyToZuidstring

Numeric user ID of the parent comment's author (long as string).

replyContentstring

Text snippet of the parent comment. Present when requested via addlData.

timestampsJSON Object

Timestamps for the comment.

Show Sub-Attributes
createdAtstring

ISO 8601 creation time of the comment.

lastModifiedAtstring

Last modification time in epoch milliseconds (long as string). Present when the comment has been edited.

commentAuthorJSON Object

Author identity of the comment.

Show Sub-Attributes
authorNamestring

Display name of the comment author.

authorIdstring

Numeric user ID of the comment author (long as string).

commentJSON Object

Core comment identity fields.

Show Sub-Attributes
customStatusinteger

Custom status value. Present when > 0.

commentTypeinteger

Numeric type of the comment. Present when > 0.

commentIdstring

Unique numeric ID of the comment (long as string).

externalIdstring

External identifier for migrated or integrated comments.

userboolean

True when posted by a real user (false for auto-generated system comments).

sequenceIdstring

Sequence ID of the comment (long as string). Present when > 0.

messageViastring

Channel through which the comment was posted ('web' or 'mobile').

stateJSON Object

State flags for the comment.

Show Sub-Attributes
hasPrivateCommentsboolean

True when there are private replies visible to the current user.

isPrivateboolean

True when this comment is a private reply to another comment.

likedboolean

True when the current user has liked the comment.

isPrivateToPostboolean

True when this is a private-to-post comment visible only to the message owner.

contentJSON Object

Comment body and media.

Show Sub-Attributes
attachmentsJSON Array

Attachments on the comment. Present when includeAttachments=true.

Show Sub-Attributes
JSON Object

An attachment on a message or comment as returned by AttachmentInfoImpl.toJSONV2 + AttachStoreInfoImpl.toJSONV2. All keys match AttachmentJSONConstantsV2.

Show Sub-Attributes
sourceIdstring

Source namespace/user ID associated with the attachment (long as string).

canBeBleachedboolean

True when the attachment can be sanitized/bleached. Present only when true.

applicationTypeinteger

Application type for cloud attachments. Present when > 0.

attachmentTypeinteger

Attachment type code (e.g. inline, regular, cloud, huge).

attachmentDocumentIdstring

Document ID associated with the attachment for Zoho Docs integration.

attachmentStatusinteger

Attachment status code.

contentIdstring

Content ID for inline (embedded) attachments. Present when set.

openWithDocIdstring

Document ID for open-with integrations. Present when set.

shareTypeinteger

Share type of the attachment.

isPasswordProtectedboolean

True when the attachment is password-protected. Present only when true.

isDeletedboolean

True when the attachment has been deleted. Present only when true.

expiryTypestring

Expiry type for time-limited attachment links. Present when set.

digeststring

Content digest/hash of the attachment. Present when set.

attachmentIdstring

Numeric attachment ID (long as string).

thumbnailHeightinteger

Image height in pixels. Present when thumbnail dimensions are available.

isAttachmentInlineboolean

True when the attachment is inline (embedded in the body).

expiryValuestring

Expiry value for time-limited attachment links. Present when set.

inferredFormatstring

Server-inferred file format when the extension is missing or ambiguous. Present when set.

scanDetailsJSON Object

Virus/malware scan details for the attachment.

Show Sub-Attributes
lastVirusScanTimestampinteger

Epoch timestamp of the last virus scan.

isScanCacheValidboolean

True when the cached scan result is still valid.

isEncryptedScanPerformedboolean

True when an encrypted scan was performed.

scanStatusstring

Result of the virus scan (e.g. 'CLEAN', 'INFECTED').

errorCodeinteger

Scan error code. Present when scanStatus indicates an error.

attachmentEncryptionStatusinteger

Encryption status code of the attachment.

isPreviewAvailableboolean

True when a web preview is available for this attachment.

isThumbnailboolean

True when this is a thumbnail attachment.

attachmentTagsarray[string]

Label/tag IDs associated with the attachment.

attachmentPartIdstring

MIME part identifier within the message.

thumbnailWidthinteger

Image width in pixels. Present when thumbnail dimensions are available.

sharedEmailIdsarray[string]

Email IDs of recipients. Present for huge attachment type only.

thumbnailDatastring

Base64-encoded JPEG thumbnail (data URI). Present for image attachments with thumbnail data.

isCommentAttachmentboolean

True when this attachment belongs to a comment.

attachmentSizestring

File size in bytes (long as string).

previewEngineFileIdstring

Preview engine file ID for document previews. Present when set.

attachmentFileTypestring

MIME type or file type identifier of the attachment.

attachmentFormatstring

File extension derived from the file name (e.g. 'pdf', 'png').

commentIdstring

Comment ID this attachment belongs to. Present when isCommentAttachment is true.

attachmentNamestring

File name of the attachment.

applicationIdstring

Application ID for cloud attachments. Present when set.

RTFboolean

True when the comment was submitted as rich text.

RTFTextstring

Raw rich-text (HTML) content. Present when RTF is true.

textstring

Plain-text content of the comment.

RTFText_sanitizedboolean

True when RTFText has been sanitized server-side.

privateToPostCommentsJSON Object

Private-to-post comments on the message. Present when includePrivateComments=true. Contains a 'privateComments' array of SmbPrivateComment objects.

Show Sub-Attributes
privateCommentsJSON Array

List of private-to-post comments visible to the current user.

Show Sub-Attributes
JSON Object

A private comment visible only to the sender and one recipient, as returned by buildPrivateCommentJSON.

Show Sub-Attributes
createdAtstring

ISO 8601 creation time of the private comment.

integrationInfosJSON Object

Integration metadata linked to the private comment. Present when the comment has integration data.

Show Sub-Attributes
idstring

ID of the integrated entity (long as string).

timestring

Timestamp of the integration event (long as string).

typestring

Integration relation type (e.g. 'CRM', 'DESK').

titlestring

Display title from the integrated source.

infostring

Additional metadata from the integrated source.

commentAuthorJSON Object

Author of the private comment.

Show Sub-Attributes
authorNamestring

Display name of the author.

authorIdstring

Numeric user ID of the author (long as string).

recipientstring

Numeric user ID of the intended recipient (long as string).

commentIdstring

Unique numeric ID of the private comment (long as string).

isPrivatestring

Always 'true' for private comments.

messageViastring

Always 'REST' for private comments created via API.

contentJSON Object

Content of the private comment.

Show Sub-Attributes
RTFboolean

True when the content is rich text.

RTFTextstring

Raw rich-text (HTML) content. Present when RTF is true.

textstring

Plain-text content.

RTFText_sanitizedboolean

True when RTFText has been sanitized.

previousPageTokenstring

Opaque token to fetch the previous page of comments. Present when start > 0.

attachmentsJSON Array

Attachments on the message. Present when includeAttachments=true is requested.

Show Sub-Attributes
JSON Object

An attachment on a message or comment as returned by AttachmentInfoImpl.toJSONV2 + AttachStoreInfoImpl.toJSONV2. All keys match AttachmentJSONConstantsV2.

Show Sub-Attributes
sourceIdstring

Source namespace/user ID associated with the attachment (long as string).

canBeBleachedboolean

True when the attachment can be sanitized/bleached. Present only when true.

applicationTypeinteger

Application type for cloud attachments. Present when > 0.

attachmentTypeinteger

Attachment type code (e.g. inline, regular, cloud, huge).

attachmentDocumentIdstring

Document ID associated with the attachment for Zoho Docs integration.

attachmentStatusinteger

Attachment status code.

contentIdstring

Content ID for inline (embedded) attachments. Present when set.

openWithDocIdstring

Document ID for open-with integrations. Present when set.

shareTypeinteger

Share type of the attachment.

isPasswordProtectedboolean

True when the attachment is password-protected. Present only when true.

isDeletedboolean

True when the attachment has been deleted. Present only when true.

expiryTypestring

Expiry type for time-limited attachment links. Present when set.

digeststring

Content digest/hash of the attachment. Present when set.

attachmentIdstring

Numeric attachment ID (long as string).

thumbnailHeightinteger

Image height in pixels. Present when thumbnail dimensions are available.

isAttachmentInlineboolean

True when the attachment is inline (embedded in the body).

expiryValuestring

Expiry value for time-limited attachment links. Present when set.

inferredFormatstring

Server-inferred file format when the extension is missing or ambiguous. Present when set.

scanDetailsJSON Object

Virus/malware scan details for the attachment.

Show Sub-Attributes
lastVirusScanTimestampinteger

Epoch timestamp of the last virus scan.

isScanCacheValidboolean

True when the cached scan result is still valid.

isEncryptedScanPerformedboolean

True when an encrypted scan was performed.

scanStatusstring

Result of the virus scan (e.g. 'CLEAN', 'INFECTED').

errorCodeinteger

Scan error code. Present when scanStatus indicates an error.

attachmentEncryptionStatusinteger

Encryption status code of the attachment.

isPreviewAvailableboolean

True when a web preview is available for this attachment.

isThumbnailboolean

True when this is a thumbnail attachment.

attachmentTagsarray[string]

Label/tag IDs associated with the attachment.

attachmentPartIdstring

MIME part identifier within the message.

thumbnailWidthinteger

Image width in pixels. Present when thumbnail dimensions are available.

sharedEmailIdsarray[string]

Email IDs of recipients. Present for huge attachment type only.

thumbnailDatastring

Base64-encoded JPEG thumbnail (data URI). Present for image attachments with thumbnail data.

isCommentAttachmentboolean

True when this attachment belongs to a comment.

attachmentSizestring

File size in bytes (long as string).

previewEngineFileIdstring

Preview engine file ID for document previews. Present when set.

attachmentFileTypestring

MIME type or file type identifier of the attachment.

attachmentFormatstring

File extension derived from the file name (e.g. 'pdf', 'png').

commentIdstring

Comment ID this attachment belongs to. Present when isCommentAttachment is true.

attachmentNamestring

File name of the attachment.

applicationIdstring

Application ID for cloud attachments. Present when set.

activityJSON Object

Social activity counters and participant lists.

Show Sub-Attributes
remindersJSON Object

Reminder data for the message. Present in activity when the message has reminders.

Show Sub-Attributes
reminderIdsarray[string]

Numeric IDs of reminders set on this message (long as string each).

reminderObjectsarray[object]

Full reminder detail objects (time, type, etc.) for each reminder.

likesCountinteger

Total number of likes.

sharedGroupsJSON Array[object]

Groups this message has been shared with.

Show Sub-Attributes
streamsEnabledboolean

Whether the group has Streams enabled.

namestring

Shared group name (or user's full name when not a group).

idstring

Shared group ID (long as string).

isGroupboolean

Whether the shared entity is a group.

inviteesCountinteger

Total number of invitees.

likedByarray[string]

Numeric user IDs of users who liked the message (long as string each).

commentsCountinteger

Total number of comments.

mentionsarray[string]

Always returned as an empty array. The API does not currently expose mentioned users through this field.

chatletsinteger

Number of chatlet interactions on the message.

inviteeListarray[string]

Numeric user IDs of invitees.

timestampsJSON Object

Time-related fields for the message.

Show Sub-Attributes
createdAtstring

Message creation time in epoch milliseconds (long as string).

displayTimestring

Time value to display in the UI, in epoch milliseconds (long as string).

updatedTimestring

Time the message content was last edited in epoch milliseconds (long as string). Present when updatedTime > 0.

pinnedTimestring

Time the message was pinned in epoch milliseconds (long as string). Present only when pinned is true.

lastModifiedAtstring

Last modification time in epoch milliseconds (long as string).

displayDatestring

Human-readable date label shown in the UI (e.g. 'TUE SEP 22').

toTimezonestring

Timezone abbreviation used for displayDate/displayTime (e.g. 'IST').

draftSentTimestring

Time the draft mail was sent in epoch milliseconds (long as string). Present for mail-type entities only.

customFieldsJSON Object

Custom field values as a map of field ID (string) to array of string values. Present when custom fields are configured for the mailbox.

Show Sub-Attributes
{key_name}array[string]
Accepts any additional properties with custom keys
threadJSON Object

Thread/conversation metadata.

Show Sub-Attributes
isConversationboolean

True when the message is part of a conversation thread.

threadCountstring

Total number of messages in the conversation thread (as string). Present when threadOverview is available.

lastReplyUserIdstring

Numeric user ID of the last person who replied ('-1' when no replies).

lastMessageIdstring

Numeric ID of the latest message in the conversation thread (long as string). Present when threadOverview is available.

conversationThreadIdstring

Numeric ID of the mail conversation thread (tid, long as string). Present when the message is part of a mail conversation.

messageJSON Object

Core mail envelope fields.

Show Sub-Attributes
messageTypestring

Numeric type of the message ('1' = mail).

displayImagestring

Display image URL for the message. Present when the message was posted via webhook with an image.

mailSpaceIdstring

Numeric ID of the mail space (account) this message belongs to (long as string). Present when mailSpaceId > 0.

messageIdstring

Unique numeric ID of the message (long as string).

fromAddressstring

Sender email address.

folderDetailsJSON Object

Mail folder details for the message. Contains folder name and folder ID from the underlying mail store.

Show Sub-Attributes
folderNamestring

System name of the mail folder holding the message.

Allowed Values :
Show Values ▾
InboxCopied!
DraftsCopied!
TemplatesCopied!
OutboxCopied!
SentCopied!
TrashCopied!
SpamCopied!
SnoozedCopied!
LocalCopied!
ArchiveCopied!
Copied!Copy all as JSON Array
folderIdstring

Numeric ID of the mail folder holding the message (long as string).

Maximum Length :19Copied!
toAddressstring

To recipient email address(es).

messageViastring

Channel through which the message was sent (e.g. 'web', 'mail').

entitySizeinteger

Approximate size of the message in bytes.

contentJSON Object

Message content fields.

Show Sub-Attributes
summarystring

Plain-text preview snippet of the message body.

htmlSummarystring

HTML-formatted summary of the message body. Present when socialView=true and the feature is enabled.

quotedCommentsJSON Array[object]

Quoted/pinned comments embedded in the message content. Present when socialView=true and quoted comments exist.

Show Sub-Attributes
createdAtstring

Creation time of the quoted comment in epoch milliseconds (long as string).

attachmentsJSON Array

Attachments on the quoted comment.

Show Sub-Attributes
JSON Object

An attachment on a message or comment as returned by AttachmentInfoImpl.toJSONV2 + AttachStoreInfoImpl.toJSONV2. All keys match AttachmentJSONConstantsV2.

Show Sub-Attributes
sourceIdstring

Source namespace/user ID associated with the attachment (long as string).

canBeBleachedboolean

True when the attachment can be sanitized/bleached. Present only when true.

applicationTypeinteger

Application type for cloud attachments. Present when > 0.

attachmentTypeinteger

Attachment type code (e.g. inline, regular, cloud, huge).

attachmentDocumentIdstring

Document ID associated with the attachment for Zoho Docs integration.

attachmentStatusinteger

Attachment status code.

contentIdstring

Content ID for inline (embedded) attachments. Present when set.

openWithDocIdstring

Document ID for open-with integrations. Present when set.

shareTypeinteger

Share type of the attachment.

isPasswordProtectedboolean

True when the attachment is password-protected. Present only when true.

isDeletedboolean

True when the attachment has been deleted. Present only when true.

expiryTypestring

Expiry type for time-limited attachment links. Present when set.

digeststring

Content digest/hash of the attachment. Present when set.

attachmentIdstring

Numeric attachment ID (long as string).

thumbnailHeightinteger

Image height in pixels. Present when thumbnail dimensions are available.

isAttachmentInlineboolean

True when the attachment is inline (embedded in the body).

expiryValuestring

Expiry value for time-limited attachment links. Present when set.

inferredFormatstring

Server-inferred file format when the extension is missing or ambiguous. Present when set.

scanDetailsJSON Object

Virus/malware scan details for the attachment.

Show Sub-Attributes
lastVirusScanTimestampinteger

Epoch timestamp of the last virus scan.

isScanCacheValidboolean

True when the cached scan result is still valid.

isEncryptedScanPerformedboolean

True when an encrypted scan was performed.

scanStatusstring

Result of the virus scan (e.g. 'CLEAN', 'INFECTED').

errorCodeinteger

Scan error code. Present when scanStatus indicates an error.

attachmentEncryptionStatusinteger

Encryption status code of the attachment.

isPreviewAvailableboolean

True when a web preview is available for this attachment.

isThumbnailboolean

True when this is a thumbnail attachment.

attachmentTagsarray[string]

Label/tag IDs associated with the attachment.

attachmentPartIdstring

MIME part identifier within the message.

thumbnailWidthinteger

Image width in pixels. Present when thumbnail dimensions are available.

sharedEmailIdsarray[string]

Email IDs of recipients. Present for huge attachment type only.

thumbnailDatastring

Base64-encoded JPEG thumbnail (data URI). Present for image attachments with thumbnail data.

isCommentAttachmentboolean

True when this attachment belongs to a comment.

attachmentSizestring

File size in bytes (long as string).

previewEngineFileIdstring

Preview engine file ID for document previews. Present when set.

attachmentFileTypestring

MIME type or file type identifier of the attachment.

attachmentFormatstring

File extension derived from the file name (e.g. 'pdf', 'png').

commentIdstring

Comment ID this attachment belongs to. Present when isCommentAttachment is true.

attachmentNamestring

File name of the attachment.

applicationIdstring

Application ID for cloud attachments. Present when set.

RTFboolean

True when the quoted comment was rich text.

authorNamestring

Display name of the quoted comment's author.

commentIdstring

ID of the quoted comment.

RTFTextstring

Rich-text content of the quoted comment. Present when RTF is true.

authorIdstring

Numeric user ID of the quoted comment's author (long as string).

contentstring

Plain-text content of the quoted comment.

RTFText_sanitizedboolean

True when RTFText has been sanitized.

onstring

Human-readable display date of the quoted comment.

titlestring

Subject / title of the message.

ccAddressstring

Cc recipient email address(es). 'Not Provided' when absent.

labelsJSON Object

Label and tag assignments for the message.

Show Sub-Attributes
groupLabelsarray[string]

Numeric IDs of group-level labels applied to the message (long as string each).

userLabelsarray[string]

Numeric IDs of user-level labels applied to the message (long as string each).

tagsJSON Array[object]

Inline quote tags within the message content, as offset markers into the message text. These are not the labels managed by the /tags endpoints.

Show Sub-Attributes
frominteger

Start character offset within the text.

tointeger

End character offset within the text.

textstring

The tagged span of text.

typestring

Tag kind. One of: MENTION, HASHTAG, QUOTE, TWEET_MENTION, LINK.

Allowed Values :
Show Values ▾
MENTIONCopied!
HASHTAGCopied!
QUOTECopied!
TWEET_MENTIONCopied!
LINKCopied!
Copied!Copy all as JSON Array
relationshipsJSON Object

Linked entity relationships for the message.

Show Sub-Attributes
associatedToJSON Array[object]

Entities this message is associated to.

Show Sub-Attributes
namespaceIdstring

Numeric namespace (mail space) ID of the linked entity (long as string).

entityTypeinteger

Numeric type of the linked entity.

entityIdstring

Numeric ID of the linked entity (long as string).

Maximum Length :19Copied!
sharedMailIdsarray[string]

IDs of shared mail entries linked to this message.

associatedFromJSON Array[object]

Entities that are associated from this message.

Show Sub-Attributes
namespaceIdstring

Numeric namespace (mail space) ID of the linked entity (long as string).

entityTypeinteger

Numeric type of the linked entity.

entityIdstring

Numeric ID of the linked entity (long as string).

Maximum Length :19Copied!
ownershipJSON Object

Ownership and assignment fields.

Show Sub-Attributes
accountIdstring

Numeric account/org ID (long as string).

assigneeListarray[string]

Numeric user IDs of all currently assigned agents (long as string each).

accessLevelinteger

Numeric access level of the current user for this message.

isOwnerboolean

True when the authenticated user is the owner of the message.

accessLevelVsInviteesJSON Object

Map of access level to the list of invitee user IDs holding that level. Keys are the numeric access level as a string.

Show Sub-Attributes
{key_name}array[string]
Accepts any additional properties with custom keys
senderJSON Object

Sender identity fields.

Show Sub-Attributes
senderIdstring

Numeric user ID of the original sender (long as string).

senderNamestring

Display name of the original sender.

latestSenderNamestring

Display name of the most recent sender (relevant in conversations).

originatorstring

Display name of the originating sender in a conversation thread. Present when the thread has multiple senders.

permissionsJSON Object

Action permissions for the current user on this message.

Show Sub-Attributes
allowCommentsboolean

True when the current user can comment on the message.

showDeleteboolean

True when the current user can delete the message.

showInviteboolean

True when the current user can invite others to the message.

stateJSON Object

Boolean flags representing the current state of the message.

Show Sub-Attributes
sharedboolean

True when the message has been shared.

pinnedboolean

True when the message is pinned.

unreadboolean

True when the message has not been read by the current user.

autoShareboolean

True when auto-share is enabled.

lockInvitesboolean

True when invitations are locked (no new invitees can be added).

watchingboolean

True when the current user is following (watching) the message.

likedboolean

True when the current user has liked the message.

trashboolean

True when the message is in trash.

archivedboolean

True when the message is in the archive view.

starredboolean

True when the message is starred.

draftboolean

True when the message is a draft.

spamboolean

True when the message is marked as spam.

hasAttachmentsstring

Whether the message has attachments ('true'/'false' as string).

sentOnlyboolean

True when only the sent copy is shown (no replies).

groupJSON Object

Shared mailbox group fields.

Show Sub-Attributes
groupNamestring

Display name of the shared mailbox.

streamsEnabledboolean

Whether streams (collaboration) features are enabled for this group.

groupIdstring

Numeric ID of the shared mailbox group (zgid, long as string).

isGroupboolean

Always true for shared mailbox messages.

previousPageTokenstring

Opaque token to retrieve the previous page. Present when start > 0. Pass as pageToken query parameter.

requestIdstring

Unique identifier for the request, useful for support and tracing.

statusJSON Object

Request status code and description (200 on success).

Example
{
  "code": 200,
  "description": "OK"
}
Show Sub-Attributes
codeinteger

HTTP-style numeric status code returned by the API (e.g. 200 for success).

descriptionstring

Human-readable text describing the outcome of the request.

- HTTP code 400

Response Body - application/json
JSON Object

Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.

Show Sub-Attributes
requestIdstring

Unique identifier of the request, useful for support and tracing.

errorJSON Object

Details of a single error, present when the request fails with one error.

Example
{
  "errorMessage": "The 'view' path parameter must be one of: all, unread, unassigned, assigned, archived, spam, trash.",
  "errorCode": "INVALID_INPUT",
  "locationType": "pathParam",
  "location": "view"
}
Show Sub-Attributes
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.

errorsJSON Array

List of errors returned when a request fails validation on multiple parameters.

Show Sub-Attributes
JSON Object

Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.

Show Sub-Attributes
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.

statusJSON Object

HTTP-like status code and human-readable description of the error.

Example
{
  "code": 200,
  "description": "OK"
}
Show Sub-Attributes
codeinteger

HTTP-style numeric status code returned by the API (e.g. 200 for success).

descriptionstring

Human-readable text describing the outcome of the request.

- HTTP code 401

Response Body - application/json
JSON Object

Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.

Show Sub-Attributes
requestIdstring

Unique identifier of the request, useful for support and tracing.

errorJSON Object

Details of a single error, present when the request fails with one error.

Example
{
  "errorMessage": "The 'view' path parameter must be one of: all, unread, unassigned, assigned, archived, spam, trash.",
  "errorCode": "INVALID_INPUT",
  "locationType": "pathParam",
  "location": "view"
}
Show Sub-Attributes
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.

errorsJSON Array

List of errors returned when a request fails validation on multiple parameters.

Show Sub-Attributes
JSON Object

Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.

Show Sub-Attributes
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.

statusJSON Object

HTTP-like status code and human-readable description of the error.

Example
{
  "code": 200,
  "description": "OK"
}
Show Sub-Attributes
codeinteger

HTTP-style numeric status code returned by the API (e.g. 200 for success).

descriptionstring

Human-readable text describing the outcome of the request.

- HTTP code 403

Response Body - application/json
JSON Object

Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.

Show Sub-Attributes
requestIdstring

Unique identifier of the request, useful for support and tracing.

errorJSON Object

Details of a single error, present when the request fails with one error.

Example
{
  "errorMessage": "The 'view' path parameter must be one of: all, unread, unassigned, assigned, archived, spam, trash.",
  "errorCode": "INVALID_INPUT",
  "locationType": "pathParam",
  "location": "view"
}
Show Sub-Attributes
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.

errorsJSON Array

List of errors returned when a request fails validation on multiple parameters.

Show Sub-Attributes
JSON Object

Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.

Show Sub-Attributes
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.

statusJSON Object

HTTP-like status code and human-readable description of the error.

Example
{
  "code": 200,
  "description": "OK"
}
Show Sub-Attributes
codeinteger

HTTP-style numeric status code returned by the API (e.g. 200 for success).

descriptionstring

Human-readable text describing the outcome of the request.

- HTTP code 404

Response Body - application/json
JSON Object

Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.

Show Sub-Attributes
requestIdstring

Unique identifier of the request, useful for support and tracing.

errorJSON Object

Details of a single error, present when the request fails with one error.

Example
{
  "errorMessage": "The 'view' path parameter must be one of: all, unread, unassigned, assigned, archived, spam, trash.",
  "errorCode": "INVALID_INPUT",
  "locationType": "pathParam",
  "location": "view"
}
Show Sub-Attributes
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.

errorsJSON Array

List of errors returned when a request fails validation on multiple parameters.

Show Sub-Attributes
JSON Object

Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.

Show Sub-Attributes
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.

statusJSON Object

HTTP-like status code and human-readable description of the error.

Example
{
  "code": 200,
  "description": "OK"
}
Show Sub-Attributes
codeinteger

HTTP-style numeric status code returned by the API (e.g. 200 for success).

descriptionstring

Human-readable text describing the outcome of the request.

- HTTP code 429

Response Body - application/json
JSON Object

Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.

Show Sub-Attributes
requestIdstring

Unique identifier of the request, useful for support and tracing.

errorJSON Object

Details of a single error, present when the request fails with one error.

Example
{
  "errorMessage": "The 'view' path parameter must be one of: all, unread, unassigned, assigned, archived, spam, trash.",
  "errorCode": "INVALID_INPUT",
  "locationType": "pathParam",
  "location": "view"
}
Show Sub-Attributes
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.

errorsJSON Array

List of errors returned when a request fails validation on multiple parameters.

Show Sub-Attributes
JSON Object

Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.

Show Sub-Attributes
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.

statusJSON Object

HTTP-like status code and human-readable description of the error.

Example
{
  "code": 200,
  "description": "OK"
}
Show Sub-Attributes
codeinteger

HTTP-style numeric status code returned by the API (e.g. 200 for success).

descriptionstring

Human-readable text describing the outcome of the request.

- HTTP code 500

Response Body - application/json
JSON Object

Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.

Show Sub-Attributes
requestIdstring

Unique identifier of the request, useful for support and tracing.

errorJSON Object

Details of a single error, present when the request fails with one error.

Example
{
  "errorMessage": "The 'view' path parameter must be one of: all, unread, unassigned, assigned, archived, spam, trash.",
  "errorCode": "INVALID_INPUT",
  "locationType": "pathParam",
  "location": "view"
}
Show Sub-Attributes
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.

errorsJSON Array

List of errors returned when a request fails validation on multiple parameters.

Show Sub-Attributes
JSON Object

Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.

Show Sub-Attributes
errorMessagestring

Human-readable description of the error.

errorCodestring

Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).

locationTypestring

Where the offending input was supplied. Omitted when 'location' is omitted.

Allowed Values :
Show Values ▾
pathParamCopied!
queryParamCopied!
requestBodyCopied!
headerCopied!
Copied!Copy all as JSON Array
locationstring

Name of the path parameter, query parameter or request body field that caused the error. Omitted when the error is not tied to a specific input.

statusJSON Object

HTTP-like status code and human-readable description of the error.

Example
{
  "code": 200,
  "description": "OK"
}
Show Sub-Attributes
codeinteger

HTTP-style numeric status code returned by the API (e.g. 200 for success).

descriptionstring

Human-readable text describing the outcome of the request.

Sample Response: HTTP 200

Copied!
  {
    "data": {
      "userInfo": {
        "600001": "Alice Johnson",
        "600002": "Bob Smith"
      },
      "nextPageToken": "eyJzdGFydCI6MTAsInRpbWVzdGFtcCI6MTc0NjE3MjgwMDAwMH0=",
      "messages": [
        {
          "relationships": {
            "associatedTo": [
              {
                "namespaceId": "100000001",
                "entityType": 1,
                "entityId": "1001234567891"
              }
            ],
            "sharedMailIds": [
              "1001234567893"
            ],
            "associatedFrom": [
              {
                "namespaceId": "100000001",
                "entityType": 6,
                "entityId": "1001234567892"
              }
            ]
          },
          "comments": {
            "totalComments": 3
          },
          "ownership": {
            "accountId": "100000001",
            "assigneeList": [
              "600002"
            ],
            "accessLevel": 2,
            "isOwner": false,
            "accessLevelVsInvitees": {
              "1": [
                "600002"
              ],
              "2": [
                "600004",
                "600005"
              ]
            }
          },
          "activity": {
            "likesCount": 1,
            "sharedGroups": [
              {
                "streamsEnabled": true,
                "name": "Support Team",
                "id": "800000002",
                "isGroup": true
              }
            ],
            "inviteesCount": 2,
            "likedBy": [
              "600001"
            ],
            "commentsCount": 3,
            "mentions": [],
            "chatlets": 0,
            "inviteeList": [
              "600001",
              "800000002"
            ]
          },
          "sender": {
            "senderId": "600003",
            "senderName": "John Doe",
            "latestSenderName": "John Doe",
            "originator": "Alice Johnson"
          },
          "timestamps": {
            "createdAt": "1746172800000",
            "displayTime": "1746172800000",
            "lastModifiedAt": "1746172800000",
            "displayDate": "FRI MAY 02",
            "toTimezone": "IST"
          },
          "permissions": {
            "allowComments": true,
            "showDelete": false,
            "showInvite": true
          },
          "state": {
            "shared": false,
            "pinned": false,
            "unread": true,
            "autoShare": false,
            "lockInvites": false,
            "watching": false,
            "liked": false,
            "trash": false,
            "archived": false,
            "starred": false,
            "draft": false,
            "spam": false,
            "hasAttachments": "false",
            "sentOnly": false
          },
          "thread": {
            "isConversation": true,
            "threadCount": "5",
            "lastReplyUserId": "600002",
            "lastMessageId": "1001234567895",
            "conversationThreadId": "9876543210"
          },
          "message": {
            "messageType": "1",
            "mailSpaceId": "800000001",
            "messageId": "1001234567890",
            "fromAddress": "john.doe@example.com",
            "folderDetails": {
              "folderName": "Inbox",
              "folderId": "800000002"
            },
            "toAddress": "support@zylker.com",
            "messageVia": "mail",
            "entitySize": 4096,
            "content": {
              "summary": "Hi, I placed order #98765 last week and would like to request a refund due to a defective item...",
              "title": "Order #98765 - Refund Request"
            },
            "ccAddress": "Not Provided"
          },
          "group": {
            "groupName": "Zylker Support",
            "streamsEnabled": true,
            "groupId": "705000001",
            "isGroup": true
          },
          "labels": {
            "groupLabels": [
              "3001234567890"
            ],
            "userLabels": [
              "3001234567891"
            ],
            "tags": [
              {
                "from": 0,
                "to": 35,
                "text": "Hi, I placed order #98765 last week",
                "type": "QUOTE"
              }
            ]
          }
        }
      ],
      "previousPageToken": "hiuJzdGFydCI6MTAsIfrhuYuybUCI6MTc0NjE3MjfhruiHUBu8="
    },
    "requestId": "zmreq-abc12345-def6-7890",
    "status": {
      "code": 200,
      "description": "OK"
    }
  }
                
▼ Show full

Sample Response: HTTP 400

Copied!
  {
    "requestId": "zmreq-abc12345-def6-7890",
    "error": {
      "errorMessage": "The 'view' path parameter must be one of: all, unread, unassigned, assigned, archived, spam, trash.",
      "errorCode": "INVALID_INPUT",
      "locationType": "pathParam",
      "location": "view"
    },
    "status": {
      "code": 400,
      "description": "Bad Request"
    }
  }
                
▼ Show full

Sample Response: HTTP 401

Copied!
  {
    "requestId": "zmreq-abc12345-def6-7890",
    "error": {
      "errorMessage": "The OAuth access token is missing, malformed or has expired.",
      "errorCode": "INVALID_INPUT"
    },
    "status": {
      "code": 401,
      "description": "Unauthorized"
    }
  }
                
▼ Show full

Sample Response: HTTP 403

Copied!
  {
    "requestId": "zmreq-abc12345-def6-7890",
    "error": {
      "errorMessage": "The authenticated user does not have permission to perform this operation on this shared mailbox.",
      "errorCode": "INVALID_INPUT"
    },
    "status": {
      "code": 403,
      "description": "Forbidden"
    }
  }
                
▼ Show full

Sample Response: HTTP 404

Copied!
  {
    "requestId": "zmreq-abc12345-def6-7890",
    "error": {
      "errorMessage": "Shared mailbox 'support@zylker.com' was not found, or the authenticated user is not a member of it.",
      "errorCode": "INVALID_INPUT"
    },
    "status": {
      "code": 404,
      "description": "Not Found"
    }
  }
                
▼ Show full

Sample Response: HTTP 429

Copied!
  {
    "requestId": "zmreq-abc12345-def6-7890",
    "error": {
      "errorMessage": "The rate limit for this API has been exceeded. Retry after the lock period has elapsed.",
      "errorCode": "INVALID_INPUT"
    },
    "status": {
      "code": 429,
      "description": "Too Many Requests"
    }
  }
                
▼ Show full

Sample Response: HTTP 500

Copied!
  {
    "requestId": "zmreq-abc12345-def6-7890",
    "error": {
      "errorMessage": "Something went wrong. Please try again later.",
      "errorCode": "INTERNAL_SERVER_ERROR"
    },
    "status": {
      "code": 500,
      "description": "Internal Server Error"
    }
  }
                
▼ Show full