Zimbra REST API Reference
Zimbra exposes its data via a REST API. This document is the reference for that functionality.
REST (REpresentational State Transfer) is an approach for building application services that make resources available via a URL. For example, the following REST command retrieves all inbox items as a simple RSS feed:
Learn more about REST at the Wikipedia article Representational State Transfer.
The format of a Zimbra REST command is:
The following describes the components of the REST command:
||The transport protocol, for example, |
||The host name or IP address of the Zimbra Collaboration Suite server|
||The port number, for example, 7070.|
||The user. To load an explicit user account, specify the user in one of the following formats:
Note: Use "~" as shortcut to the currently authenticated user. For example:
The API supports the following methods to retrieve Zimbra data.