Zimbra REST API: Item Methods | Zimbra

Alert! This article is written for Zimbra OSE users. As of December 2023, Synacor will no longer be providing support for Zimbra OSE. You might want to consider trying out Carbonio Community Edition – Zextras’s free and open-source email and collaboration platform.

For additional guidance, check out our community articles detailing the process of migrating from your current platform to Carbonio CE.

In this article we are going to analyze the Item methods of the Zimbra REST API. For an overview and in-depth coverage about it, we refer you to the related article in our technical blog.

Get Item

This method retrieves items. The HTTP method to read data is get.

The basic URL structure is the following one:


Item Id

This method requires the id of the item to be retrieved: id={item-id}.


The supported formats vary depending on the type of object being recovered. Below is a table that summarizes the different types to choose from:

TypeFormatsDefault Format
e-mail Messagejson, xml, rss, atom, zip, tar, tgz, syncDefault format is MIME
Appointmentjson, xml, icsDefault format is ics
Contactjson, xml, vcfDefault format is vcf
Taskjson, xml, ics, rss, atomDefault format is ics


We have different parameters for this method. The basic ones are:

  • id – the message id is required.
  • fmt – the reply format is optional.

There are also two Mail Message Parameters, both optional:

  • imap_id – this specifies an IMAP id
  • part – this specifies which part of the MIME message to retrieve.


To retrieve an email message with id 55 as default MIME RFC822 format:


If you want to retrieve the contact with id 712 in XML format:

Download Zextras Suite for Zimbra OSE

Post your comment

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Zimbra REST API: Task Methods | Zimbra
Zimbra REST API: Briefcase Methods | Zimbra