Common rules
Advanced searches
.../v1/searchQueries/schema.{format}
.../v1/searchQueries.{format}
.../v1/searchQueries/{advancedSearchId}.{format}
Alert service global setting
.../v1/alertserviceglobalsetting/schema.{format}
.../v1/alertserviceglobalsetting.{format}
.../v1/alertserviceglobalsetting/count.{format}
Alert service policies
.../v1/alertservicepolicies/schema.{format}
.../v1/alertservicepolicies.{format}
.../v1/alertservicepolicies/count.{format}
.../v1/alertservicepolicies/{alertServicePolicyId}.{format}
Alert service queries
Attachments
.../v1/attachments/schema.{format}
.../v1/attachments.{format}
.../v1/attachments/{checksum}
.../v1/attachments/{checksum}/web.{format}
.../v1/attachments/zip.{format}
.../v1/attachments/{checksumOrId}/aliases.{format}
.../v1/attachments/file/accesshistory/schema.{format}
.../v1/attachments/file/{checksumOrId}/accesshistories.{format}
Authentication (login)
Configurations
Contacts
Delegations
.../v1/delegations/signup.{format}
.../v1/delegations/signoff.{format}
.../v1/delegationstatuses.{format}
.../v1/delegationlogs/logins/{loginId}/mailboxes/{mailboxId}.{format}
Exported searches
Folders
.../v1/folders/schema.{format}
.../v1/folders.{format}
.../v1/folders/{folderId}.{format}
.../v1/folders/{folderId}/messages.{format}
.../v1/folders/{folderId}/messages/count.{format}
.../v1/folders/{folderId}/messages/{messageId}.{format}
.../v1/folders/{parentFolderId}/subfolders.{format}
.../v1/folders/{parentFolderId}/subfolders/count.{format}
.../v1/folders/{parentFolderId}/subfolders/{subfolderId}.{format}
Groups
.../v1/groups/schema.{format}
.../v1/groups.{format}
.../v1/groups/count.{format}
.../v1/groups/{groupId}.{format}
.../v1/groups/{groupId}/logins.{format}
.../v1/groups/{groupId}/logins/count.{format}
.../v1/groups/{groupId}/logins/{loginId}.{format}
Logins
.../v1/logins/schema.{format}
.../v1/logins.{format}
.../v1/logins/me.{format}
.../v1/logins/count.{format}
.../v1/logins/{loginId}.{format}
.../v1/logins/{loginId}/mailboxes.{format}
.../v1/logins/{loginId}/mailboxes/count.{format}
.../v1/logins/{loginId}/mailboxes/{mailboxId}.{format}
Login domains
.../v1/logindomains/schema.{format}
.../v1/logindomains.{format}
...v1/logindomains/count.{format}
.../v1/logindomains/{logindomainId}.{format}
.../v1/logindomains/{logindomainId}/logins.{format}
.../v1/logindomains/{logindomainId}/logins/count.{format}
.../v1/logindomains/{logindomainId}/logins/{loginId}.{format}
Mailboxes
.../v1/mailboxes/schema.{format}
.../v1/mailboxes.{format}
.../v1/mailboxes/count.{format}
.../v1/mailboxes/{mailboxId}.{format}
.../v1/mailboxes/{mailboxId}/folders.{format}
.../v1/mailboxes/{mailboxId}/folders/count.{format}
.../v1/mailboxes/{mailboxId}/logins.{format}
.../v1/mailboxes/{mailboxId}/messages.{format}
.../v1/mailboxes/{mailboxId}/messages/count.{format}
.../v1/mailboxes/{mailboxId}/messages/{messageId}.{format}
Mailstores
.../v1/mailstores/schema.{format}
.../v1/mailstores.{format}
.../v1/mailstores/count.{format}
.../v1/mailstores/{mailstoreId}.{format}
.../v1/mailstores/{mailstoreId}/mailboxes.{format}
.../v1/mailstores/{mailstoreId}/mailboxes/count.{format}
Messages
.../v1/messages/schema.{format}
.../v1/messages.{format}
.../v1/messages/{messageId}.{format}
.../v1/messages/{messageId}/html.{format}
.../v1/messages/{messageId}/plaintext.{format}
.../v1/messages/{messageId}/raw.{format}
.../v1/messages/{messageId}/rtf.{format}
.../v1/messages/{checksum}/bodyhtml
.../v1/messages/{checksum}/eml
.../v1/messages/{checksum}/sendmail.{format}
.../v1/messages/{checksum}/web.{format}
.../v1/messages/searchresults/schema.{format}
.../v1/messages/rtfImage/{fileName}
.../v1/messages/web/schema.{format}
.../v1/messages/web.{format}
.../v1/messages/{checksumOrId}/accesshistories.{format}
.../v1/messages/{checksumOrId}/availabletags.{format}
.../v1/messages/{checksumOrId}/comments.{format}
.../v1/messages/{checksumOrId}/journalreports.{format}
.../v1/messages/{checksumOrId}/tags.{format}
.../v1/messages/{checksumOrId}/tags/{tagId}.{format}
Message comments
Message folders
Message tags
Message types
Organizational units
.../v1/organizationalunits/schema.{format}
.../v1/organizationalunits.{format}
.../v1/organizationalunits/count.{format}
.../v1/organizationalunits/{organizationalunitsId}.{format}
.../v1/organizationalunits/{organizationalunitsId}/logins.{format}
.../v1/organizationalunits/{organizationalunitsId}/logins/count.{format}
.../v1/organizationalunits/{organizationalunitsId}/mailboxes.{format}
.../v1/organizationalunits/{organizationalunitsId}/mailboxes/count.{format}
Product
.../v1/product/license.{format}
.../v1/product/version.{format}
.../v1/product/legalnotice/schema.{format}
.../v1/product/legalnoticelist.{format}
Retention change logs
.../v1/retentionchangelogs/schema.{format}
.../v1/retentionchangelogs.{format}
.../v1/retentionchangelogs/{retentionchangelogsId}.{format}
Retention holds
.../v1/retentionholds/schema.{format}
.../v1/retentionholds.{format}
.../v1/retentionholds/{retentionholdId}.{format}
Retention message logs
.../v1/retentionmessagelogs/schema.{format}
.../v1/retentionmessagelogs.{format}
.../v1/retentionmessagelogs/count.{format}
.../v1/retentionmessagelogs/{retentionMessageLogId}.{format}
.../v1/retentionmessagelogs/report/schema.{format}
.../v1/retentionmessagelogs/report.{format}
Retention policies
.../v1/retentionpolicies/schema.{format}
.../v1/retentionpolicies.{format}
.../v1/retentionpolicies/{retentionpolicyId}.{format}
.../v1/retentionpolicies/retentionpolicyset.{format}
Retention runs
.../v1/retentionruns/schema.{format}
.../v1/retentionruns.{format}
.../v1/retentionruns/count.{format}
.../v1/retentionruns/{retentionrunId}.{format}
.../v1/retentionruns/{retentionrunId}/abort.{format}
.../v1/retentionruns/{retentionrunId}/report.{format}
.../v1/retentionruns/{retentionrunId}/review.{format}
.../v1/retentionruns/{retentionrunId}/retentionrunpolicies.{format}
.../v1/retentionruns/{retentionrunId}/retentionrunpolicies/count.{format}
Retention run policies
.../v1/retentionrunpolicies/schema.{format}
.../v1/retentionrunpolicies.{format}
.../v1/retentionrunpolicies/count.{format}
.../v1/retentionrunpolicies/{retentionrunpolicyId}.{format}
Retention schedule
Retention settings
Security roles
.../v1/securityroles/schema.{format}
.../v1/securityroles.{format}
.../v1/securityroles/{securityRoleId}.{format}
.../v1/securityroles/{securityRoleId}/logins.{format}
Server
Tags
Supported HTTP method
GET
|
• |
|
• |
|
• |
|
• |
|
• |
|
• |
|
• |
|
• |
ftsScope: For example, ftsScope:Subject|Body. |
|
• |
|
• |
|
• |
|
• |
attachmentType: Separate multiple types by semicolon, for example, txt;pdf;docx. Use the symbol "!" to exclude a file type, for example, !txt;!pdf, this will search for messages that do not have TXT or PDF attachment(s). |
|
• |
tagName: Separate multiple tags by semicolon, for example, tagName:Food;Fruit. Use the symbol "!" to exclude a tag, for example, tagName:!Food;!Fruit. |
|
• |
|
• |
|
• |
|
• |
|
TIP: For example, to search all emails, .../v1/messages.json?query=searchallemails:true to search emails by query ID, .../v1/messages.json?queryid=S0VZOkxPQ0FMOjE7YTYwYjkzM2M1NmE0MGQ0OGIwNGQzY2Y5MmUxMzA2OTF8MjAxNTA4MTQwNjAzMzFaXzE3ZQ== to search emails by Full Text Search, .../v1/messages.json?query=ftsquery:Software,ftsscope:All |
JSON response sample
POST
Creates a message and associates it with the current login ID.