List messages by view
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.
Endpoint
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
Request Parameters
- Path Parameters
Email address or numeric zgid (group ID) of the shared mailbox group.
View to list messages from. 'all': all messages; 'unread': unread only; 'unassigned': no assignee; 'assigned': has an assignee; 'archived': archived; 'spam': spam; 'trash': trashed.
- Query Parameters
0-based index of the first message to return. Minimum 0. Defaults to 0.
Maximum number of messages to return per page. Range: 1 to 200. Defaults to 10.
When true, fetches the previous page relative to the current position. Defaults to false.
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.
Opaque pagination cursor returned by a previous response. Pass this value to fetch the next or previous page of results.
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.
Sample Request
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'import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;
public class Main {
public static void main(String[] args) throws Exception{
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
import http.client
conn = http.client.HTTPSConnection("mail.zoho.com")
headers = { 'Authorization': "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52" }
conn.request("GET", "/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", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
parameters = "start=0" + "&" + "limit=10" + "&" + "isPrev=false" + "&" + "lastModifiedTime=1746172800000" + "&" + "pageToken=eyJzdGFydCI6MTAsImxpbWl0IjoxMH0" + "&" + "fields=messageId%2Ctitle%2CfromAddress%2CtoAddress%2CcreatedAt%2Cunread";
headersMap = Map();
headersMap.put("Accept", "application/json");
response = invokeUrl
[
url: "https://mail.zoho.com/api/v2/sharedmailbox/{mailboxIdentifier}/messages/{view}" + "?" + parameters
type: GET
headers: headersMap
connection: connection_name
]
info response;
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}Response Parameters
- HTTP code 200
Response Body - application/json
Response envelope for list-messages operations.
Show Sub-Attributes
Messages and optional pagination tokens.
Show Sub-Attributes
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
Opaque token to retrieve the next page. Absent when there are no more results. Pass as pageToken query parameter.
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
A shared mailbox message as returned in list views. Fields are grouped into nested objects matching the API response structure.
Show Sub-Attributes
Integration metadata linked to the message (e.g. associated Zoho CRM deals, Desk tickets). Present when the message has associated integrations.
Show Sub-Attributes
Whether to generate a view for this integration. Present in migration context only.
ID of the integrated entity (long as string).
Timestamp of the integration event (long as string).
Integration relation type name (e.g. 'CRM', 'DESK').
Display title from the integrated source.
Additional metadata from the integrated source.
Comment section for the message. In list views contains only totalComments; in detail view also contains commentItems and optionally privateToPostComments.
Show Sub-Attributes
Total number of comments on the message.
Opaque token to fetch the next page of comments. Present when more comments exist.
Full comment objects. Present when includeComment=true is requested.
Show Sub-Attributes
A comment on a shared mailbox message as returned by getCommentJSONV2. Fields are grouped into nested objects.
Show Sub-Attributes
Integration metadata linked to the comment. Present when the comment was created via a Zoho integration.
Show Sub-Attributes
ID of the integrated entity (long as string).
Timestamp of the integration event (long as string).
Integration relation type (e.g. 'CRM', 'DESK').
Display title from the integrated source.
Additional metadata from the integrated source.
Private replies on this comment. Present when includePrivateComments=true and private replies exist.
Show Sub-Attributes
List of private replies on this comment.
Show Sub-Attributes
A private comment visible only to the sender and one recipient, as returned by buildPrivateCommentJSON.
Show Sub-Attributes
ISO 8601 creation time of the private comment.
Integration metadata linked to the private comment. Present when the comment has integration data.
Show Sub-Attributes
ID of the integrated entity (long as string).
Timestamp of the integration event (long as string).
Integration relation type (e.g. 'CRM', 'DESK').
Display title from the integrated source.
Additional metadata from the integrated source.
Author of the private comment.
Show Sub-Attributes
Display name of the author.
Numeric user ID of the author (long as string).
Numeric user ID of the intended recipient (long as string).
Unique numeric ID of the private comment (long as string).
Always 'true' for private comments.
Always 'REST' for private comments created via API.
Content of the private comment.
Show Sub-Attributes
True when the content is rich text.
Raw rich-text (HTML) content. Present when RTF is true.
Plain-text content.
True when RTFText has been sanitized.
Social activity and metadata on the comment.
Show Sub-Attributes
Reminder IDs associated with the comment (long as string each). Present when reminders exist.
Number of likes on the comment.
Numeric user IDs of users who liked the comment (long as string each). Present when likesCount > 0.
Inline quote tags within the comment text, as offset markers into the comment content.
Show Sub-Attributes
Start character offset within the text.
End character offset within the text.
The tagged span of text.
Tag kind. One of: MENTION, HASHTAG, QUOTE, TWEET_MENTION, LINK.
Reply-to context when the comment is a threaded reply to another comment. Present only when replyTo is set.
Show Sub-Attributes
Display name of the parent comment's author.
Comment ID of the parent comment being replied to.
Numeric user ID of the parent comment's author (long as string).
Text snippet of the parent comment. Present when requested via addlData.
Timestamps for the comment.
Show Sub-Attributes
ISO 8601 creation time of the comment.
Last modification time in epoch milliseconds (long as string). Present when the comment has been edited.
Author identity of the comment.
Show Sub-Attributes
Display name of the comment author.
Numeric user ID of the comment author (long as string).
Core comment identity fields.
Show Sub-Attributes
Custom status value. Present when > 0.
Numeric type of the comment. Present when > 0.
Unique numeric ID of the comment (long as string).
External identifier for migrated or integrated comments.
True when posted by a real user (false for auto-generated system comments).
Sequence ID of the comment (long as string). Present when > 0.
Channel through which the comment was posted ('web' or 'mobile').
State flags for the comment.
Show Sub-Attributes
True when there are private replies visible to the current user.
True when this comment is a private reply to another comment.
True when the current user has liked the comment.
True when this is a private-to-post comment visible only to the message owner.
Comment body and media.
Show Sub-Attributes
Attachments on the comment. Present when includeAttachments=true.
Show Sub-Attributes
An attachment on a message or comment as returned by AttachmentInfoImpl.toJSONV2 + AttachStoreInfoImpl.toJSONV2. All keys match AttachmentJSONConstantsV2.
Show Sub-Attributes
Source namespace/user ID associated with the attachment (long as string).
True when the attachment can be sanitized/bleached. Present only when true.
Application type for cloud attachments. Present when > 0.
Attachment type code (e.g. inline, regular, cloud, huge).
Document ID associated with the attachment for Zoho Docs integration.
Attachment status code.
Content ID for inline (embedded) attachments. Present when set.
Document ID for open-with integrations. Present when set.
Share type of the attachment.
True when the attachment is password-protected. Present only when true.
True when the attachment has been deleted. Present only when true.
Expiry type for time-limited attachment links. Present when set.
Content digest/hash of the attachment. Present when set.
Numeric attachment ID (long as string).
Image height in pixels. Present when thumbnail dimensions are available.
True when the attachment is inline (embedded in the body).
Public/shared URL for cloud-linked or huge attachments.
Expiry value for time-limited attachment links. Present when set.
Server-inferred file format when the extension is missing or ambiguous. Present when set.
Virus/malware scan details for the attachment.
Show Sub-Attributes
Epoch timestamp of the last virus scan.
True when the cached scan result is still valid.
True when an encrypted scan was performed.
Result of the virus scan (e.g. 'CLEAN', 'INFECTED').
Scan error code. Present when scanStatus indicates an error.
Encryption status code of the attachment.
True when a web preview is available for this attachment.
True when this is a thumbnail attachment.
Label/tag IDs associated with the attachment.
MIME part identifier within the message.
Image width in pixels. Present when thumbnail dimensions are available.
Email IDs of recipients. Present for huge attachment type only.
Base64-encoded JPEG thumbnail (data URI). Present for image attachments with thumbnail data.
True when this attachment belongs to a comment.
File size in bytes (long as string).
Preview engine file ID for document previews. Present when set.
MIME type or file type identifier of the attachment.
File extension derived from the file name (e.g. 'pdf', 'png').
Comment ID this attachment belongs to. Present when isCommentAttachment is true.
File name of the attachment.
Application ID for cloud attachments. Present when set.
True when the comment was submitted as rich text.
Link preview data embedded in the comment.
Show Sub-Attributes
Title of the linked page.
Video URL if the link is a video.
Description of the linked page.
Preview image URLs.
URL of the linked page.
Embeddable HTML content for the link preview.
Tags associated with the link.
Raw rich-text (HTML) content. Present when RTF is true.
Plain-text content of the comment.
True when RTFText has been sanitized server-side.
Private-to-post comments on the message. Present when includePrivateComments=true. Contains a 'privateComments' array of SmbPrivateComment objects.
Show Sub-Attributes
List of private-to-post comments visible to the current user.
Show Sub-Attributes
A private comment visible only to the sender and one recipient, as returned by buildPrivateCommentJSON.
Show Sub-Attributes
ISO 8601 creation time of the private comment.
Integration metadata linked to the private comment. Present when the comment has integration data.
Show Sub-Attributes
ID of the integrated entity (long as string).
Timestamp of the integration event (long as string).
Integration relation type (e.g. 'CRM', 'DESK').
Display title from the integrated source.
Additional metadata from the integrated source.
Author of the private comment.
Show Sub-Attributes
Display name of the author.
Numeric user ID of the author (long as string).
Numeric user ID of the intended recipient (long as string).
Unique numeric ID of the private comment (long as string).
Always 'true' for private comments.
Always 'REST' for private comments created via API.
Content of the private comment.
Show Sub-Attributes
True when the content is rich text.
Raw rich-text (HTML) content. Present when RTF is true.
Plain-text content.
True when RTFText has been sanitized.
Opaque token to fetch the previous page of comments. Present when start > 0.
Attachments on the message. Present when includeAttachments=true is requested.
Show Sub-Attributes
An attachment on a message or comment as returned by AttachmentInfoImpl.toJSONV2 + AttachStoreInfoImpl.toJSONV2. All keys match AttachmentJSONConstantsV2.
Show Sub-Attributes
Source namespace/user ID associated with the attachment (long as string).
True when the attachment can be sanitized/bleached. Present only when true.
Application type for cloud attachments. Present when > 0.
Attachment type code (e.g. inline, regular, cloud, huge).
Document ID associated with the attachment for Zoho Docs integration.
Attachment status code.
Content ID for inline (embedded) attachments. Present when set.
Document ID for open-with integrations. Present when set.
Share type of the attachment.
True when the attachment is password-protected. Present only when true.
True when the attachment has been deleted. Present only when true.
Expiry type for time-limited attachment links. Present when set.
Content digest/hash of the attachment. Present when set.
Numeric attachment ID (long as string).
Image height in pixels. Present when thumbnail dimensions are available.
True when the attachment is inline (embedded in the body).
Public/shared URL for cloud-linked or huge attachments.
Expiry value for time-limited attachment links. Present when set.
Server-inferred file format when the extension is missing or ambiguous. Present when set.
Virus/malware scan details for the attachment.
Show Sub-Attributes
Epoch timestamp of the last virus scan.
True when the cached scan result is still valid.
True when an encrypted scan was performed.
Result of the virus scan (e.g. 'CLEAN', 'INFECTED').
Scan error code. Present when scanStatus indicates an error.
Encryption status code of the attachment.
True when a web preview is available for this attachment.
True when this is a thumbnail attachment.
Label/tag IDs associated with the attachment.
MIME part identifier within the message.
Image width in pixels. Present when thumbnail dimensions are available.
Email IDs of recipients. Present for huge attachment type only.
Base64-encoded JPEG thumbnail (data URI). Present for image attachments with thumbnail data.
True when this attachment belongs to a comment.
File size in bytes (long as string).
Preview engine file ID for document previews. Present when set.
MIME type or file type identifier of the attachment.
File extension derived from the file name (e.g. 'pdf', 'png').
Comment ID this attachment belongs to. Present when isCommentAttachment is true.
File name of the attachment.
Application ID for cloud attachments. Present when set.
Social activity counters and participant lists.
Show Sub-Attributes
Reminder data for the message. Present in activity when the message has reminders.
Show Sub-Attributes
Numeric IDs of reminders set on this message (long as string each).
Full reminder detail objects (time, type, etc.) for each reminder.
Total number of likes.
Groups this message has been shared with.
Show Sub-Attributes
Whether the group has Streams enabled.
Shared group name (or user's full name when not a group).
Shared group ID (long as string).
Whether the shared entity is a group.
Total number of invitees.
Numeric user IDs of users who liked the message (long as string each).
Total number of comments.
Always returned as an empty array. The API does not currently expose mentioned users through this field.
Number of chatlet interactions on the message.
Numeric user IDs of invitees.
Time-related fields for the message.
Show Sub-Attributes
Message creation time in epoch milliseconds (long as string).
Time value to display in the UI, in epoch milliseconds (long as string).
Time the message content was last edited in epoch milliseconds (long as string). Present when updatedTime > 0.
Time the message was pinned in epoch milliseconds (long as string). Present only when pinned is true.
Last modification time in epoch milliseconds (long as string).
Human-readable date label shown in the UI (e.g. 'TUE SEP 22').
Timezone abbreviation used for displayDate/displayTime (e.g. 'IST').
Time the draft mail was sent in epoch milliseconds (long as string). Present for mail-type entities only.
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
Thread/conversation metadata.
Show Sub-Attributes
True when the message is part of a conversation thread.
Total number of messages in the conversation thread (as string). Present when threadOverview is available.
Numeric user ID of the last person who replied ('-1' when no replies).
Numeric ID of the latest message in the conversation thread (long as string). Present when threadOverview is available.
Numeric ID of the mail conversation thread (tid, long as string). Present when the message is part of a mail conversation.
Core mail envelope fields.
Show Sub-Attributes
Numeric type of the message ('1' = mail).
Display image URL for the message. Present when the message was posted via webhook with an image.
Numeric ID of the mail space (account) this message belongs to (long as string). Present when mailSpaceId > 0.
Unique numeric ID of the message (long as string).
Sender email address.
Mail folder details for the message. Contains folder name and folder ID from the underlying mail store.
Show Sub-Attributes
System name of the mail folder holding the message.
Numeric ID of the mail folder holding the message (long as string).
To recipient email address(es).
Channel through which the message was sent (e.g. 'web', 'mail').
Approximate size of the message in bytes.
Message content fields.
Show Sub-Attributes
Plain-text preview snippet of the message body.
HTML-formatted summary of the message body. Present when socialView=true and the feature is enabled.
Quoted/pinned comments embedded in the message content. Present when socialView=true and quoted comments exist.
Show Sub-Attributes
Creation time of the quoted comment in epoch milliseconds (long as string).
Attachments on the quoted comment.
Show Sub-Attributes
An attachment on a message or comment as returned by AttachmentInfoImpl.toJSONV2 + AttachStoreInfoImpl.toJSONV2. All keys match AttachmentJSONConstantsV2.
Show Sub-Attributes
Source namespace/user ID associated with the attachment (long as string).
True when the attachment can be sanitized/bleached. Present only when true.
Application type for cloud attachments. Present when > 0.
Attachment type code (e.g. inline, regular, cloud, huge).
Document ID associated with the attachment for Zoho Docs integration.
Attachment status code.
Content ID for inline (embedded) attachments. Present when set.
Document ID for open-with integrations. Present when set.
Share type of the attachment.
True when the attachment is password-protected. Present only when true.
True when the attachment has been deleted. Present only when true.
Expiry type for time-limited attachment links. Present when set.
Content digest/hash of the attachment. Present when set.
Numeric attachment ID (long as string).
Image height in pixels. Present when thumbnail dimensions are available.
True when the attachment is inline (embedded in the body).
Public/shared URL for cloud-linked or huge attachments.
Expiry value for time-limited attachment links. Present when set.
Server-inferred file format when the extension is missing or ambiguous. Present when set.
Virus/malware scan details for the attachment.
Show Sub-Attributes
Epoch timestamp of the last virus scan.
True when the cached scan result is still valid.
True when an encrypted scan was performed.
Result of the virus scan (e.g. 'CLEAN', 'INFECTED').
Scan error code. Present when scanStatus indicates an error.
Encryption status code of the attachment.
True when a web preview is available for this attachment.
True when this is a thumbnail attachment.
Label/tag IDs associated with the attachment.
MIME part identifier within the message.
Image width in pixels. Present when thumbnail dimensions are available.
Email IDs of recipients. Present for huge attachment type only.
Base64-encoded JPEG thumbnail (data URI). Present for image attachments with thumbnail data.
True when this attachment belongs to a comment.
File size in bytes (long as string).
Preview engine file ID for document previews. Present when set.
MIME type or file type identifier of the attachment.
File extension derived from the file name (e.g. 'pdf', 'png').
Comment ID this attachment belongs to. Present when isCommentAttachment is true.
File name of the attachment.
Application ID for cloud attachments. Present when set.
True when the quoted comment was rich text.
Display name of the quoted comment's author.
ID of the quoted comment.
Rich-text content of the quoted comment. Present when RTF is true.
Numeric user ID of the quoted comment's author (long as string).
Plain-text content of the quoted comment.
True when RTFText has been sanitized.
Human-readable display date of the quoted comment.
Subject / title of the message.
Cc recipient email address(es). 'Not Provided' when absent.
Label and tag assignments for the message.
Show Sub-Attributes
Numeric IDs of group-level labels applied to the message (long as string each).
Numeric IDs of user-level labels applied to the message (long as string each).
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
Start character offset within the text.
End character offset within the text.
The tagged span of text.
Tag kind. One of: MENTION, HASHTAG, QUOTE, TWEET_MENTION, LINK.
Linked entity relationships for the message.
Show Sub-Attributes
Entities this message is associated to.
Show Sub-Attributes
Numeric namespace (mail space) ID of the linked entity (long as string).
Numeric type of the linked entity.
Numeric ID of the linked entity (long as string).
IDs of shared mail entries linked to this message.
Entities that are associated from this message.
Show Sub-Attributes
Numeric namespace (mail space) ID of the linked entity (long as string).
Numeric type of the linked entity.
Numeric ID of the linked entity (long as string).
Ownership and assignment fields.
Show Sub-Attributes
Numeric account/org ID (long as string).
Numeric user IDs of all currently assigned agents (long as string each).
Numeric access level of the current user for this message.
True when the authenticated user is the owner of the message.
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
Sender identity fields.
Show Sub-Attributes
Numeric user ID of the original sender (long as string).
Display name of the original sender.
Display name of the most recent sender (relevant in conversations).
Display name of the originating sender in a conversation thread. Present when the thread has multiple senders.
Action permissions for the current user on this message.
Show Sub-Attributes
True when the current user can comment on the message.
True when the current user can delete the message.
True when the current user can invite others to the message.
Boolean flags representing the current state of the message.
Show Sub-Attributes
True when the message has been shared.
True when the message is pinned.
True when the message has not been read by the current user.
True when auto-share is enabled.
True when invitations are locked (no new invitees can be added).
True when the current user is following (watching) the message.
True when the current user has liked the message.
True when the message is in trash.
True when the message is in the archive view.
True when the message is starred.
True when the message is a draft.
True when the message is marked as spam.
Whether the message has attachments ('true'/'false' as string).
True when only the sent copy is shown (no replies).
Shared mailbox group fields.
Show Sub-Attributes
Display name of the shared mailbox.
Whether streams (collaboration) features are enabled for this group.
Numeric ID of the shared mailbox group (zgid, long as string).
Always true for shared mailbox messages.
Opaque token to retrieve the previous page. Present when start > 0. Pass as pageToken query parameter.
Unique identifier for the request, useful for support and tracing.
Request status code and description (200 on success).
{
"code": 200,
"description": "OK"
}Show Sub-Attributes
HTTP-style numeric status code returned by the API (e.g. 200 for success).
Human-readable text describing the outcome of the request.
- HTTP code 400
Response Body - application/json
Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.
Show Sub-Attributes
Unique identifier of the request, useful for support and tracing.
Details of a single error, present when the request fails with one error.
{
"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
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
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.
List of errors returned when a request fails validation on multiple parameters.
Show Sub-Attributes
Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.
Show Sub-Attributes
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
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.
HTTP-like status code and human-readable description of the error.
{
"code": 200,
"description": "OK"
}Show Sub-Attributes
HTTP-style numeric status code returned by the API (e.g. 200 for success).
Human-readable text describing the outcome of the request.
- HTTP code 401
Response Body - application/json
Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.
Show Sub-Attributes
Unique identifier of the request, useful for support and tracing.
Details of a single error, present when the request fails with one error.
{
"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
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
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.
List of errors returned when a request fails validation on multiple parameters.
Show Sub-Attributes
Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.
Show Sub-Attributes
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
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.
HTTP-like status code and human-readable description of the error.
{
"code": 200,
"description": "OK"
}Show Sub-Attributes
HTTP-style numeric status code returned by the API (e.g. 200 for success).
Human-readable text describing the outcome of the request.
- HTTP code 403
Response Body - application/json
Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.
Show Sub-Attributes
Unique identifier of the request, useful for support and tracing.
Details of a single error, present when the request fails with one error.
{
"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
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
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.
List of errors returned when a request fails validation on multiple parameters.
Show Sub-Attributes
Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.
Show Sub-Attributes
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
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.
HTTP-like status code and human-readable description of the error.
{
"code": 200,
"description": "OK"
}Show Sub-Attributes
HTTP-style numeric status code returned by the API (e.g. 200 for success).
Human-readable text describing the outcome of the request.
- HTTP code 404
Response Body - application/json
Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.
Show Sub-Attributes
Unique identifier of the request, useful for support and tracing.
Details of a single error, present when the request fails with one error.
{
"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
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
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.
List of errors returned when a request fails validation on multiple parameters.
Show Sub-Attributes
Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.
Show Sub-Attributes
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
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.
HTTP-like status code and human-readable description of the error.
{
"code": 200,
"description": "OK"
}Show Sub-Attributes
HTTP-style numeric status code returned by the API (e.g. 200 for success).
Human-readable text describing the outcome of the request.
- HTTP code 429
Response Body - application/json
Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.
Show Sub-Attributes
Unique identifier of the request, useful for support and tracing.
Details of a single error, present when the request fails with one error.
{
"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
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
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.
List of errors returned when a request fails validation on multiple parameters.
Show Sub-Attributes
Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.
Show Sub-Attributes
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
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.
HTTP-like status code and human-readable description of the error.
{
"code": 200,
"description": "OK"
}Show Sub-Attributes
HTTP-style numeric status code returned by the API (e.g. 200 for success).
Human-readable text describing the outcome of the request.
- HTTP code 500
Response Body - application/json
Standard error envelope returned for failed requests. Exactly one of 'error' (single error) or 'errors' (multiple validation errors) is present.
Show Sub-Attributes
Unique identifier of the request, useful for support and tracing.
Details of a single error, present when the request fails with one error.
{
"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
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
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.
List of errors returned when a request fails validation on multiple parameters.
Show Sub-Attributes
Details of a single error. 'location' and 'locationType' are present only when the error is attributable to a specific input.
Show Sub-Attributes
Human-readable description of the error.
Application-level error code. INVALID_INPUT for client-side failures (400, 401, 403, 404); INTERNAL_SERVER_ERROR for unexpected server failures (500).
Where the offending input was supplied. Omitted when 'location' is omitted.
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.
HTTP-like status code and human-readable description of the error.
{
"code": 200,
"description": "OK"
}Show Sub-Attributes
HTTP-style numeric status code returned by the API (e.g. 200 for success).
Human-readable text describing the outcome of the request.
Sample Response: HTTP 200
{
"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"
}
}
Sample Response: HTTP 400
{
"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"
}
}
Sample Response: HTTP 401
{
"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"
}
}
Sample Response: HTTP 403
{
"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"
}
}
Sample Response: HTTP 404
{
"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"
}
}
Sample Response: HTTP 429
{
"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"
}
}
Sample Response: HTTP 500
{
"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"
}
}
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.