Zimbra REST API Reference:Get Briefcase


Method: Get Folder  

Method: Import Message  

Method: Get Contacts  

Method: Import Contacts  

Method: Get Calendar  

Method: Get FreeBusy  

Method: Import Appointments  

Method: Get Tasks  

Method: Get Item  

Method: Get Briefcase  

Method: Get Briefcase Item  

Method: Export Mailbox  


Developer Article

Article Information

This article applies to the following ZCS versions.

ZCS 7.0 Article ZCS 7.0 ZCS 6.0 Article ZCS 6.0

<< Back to Zimbra REST API Reference

REST API Method: Get Briefcase

Gets the list of items in the briefcase folder. The default folder is "Briefcase" but user-defined folders are also supported.



Go to Command Format

HTTP Method



xml,json,rss,zip,tar,tgz (Go to Response Formats)

Note: When using the zip,tar,tgz formats, the items in the briefcase folder are packaged in the archive.

Requires Authentication

true (Go to Authentication)


  • fmt. Required. The response format.

Usage Examples

Retrieve a directory of the "Briefcase" folder (this will include a list of sub-folders and documents):


Retrieve the list of items in the "Briefcase" folder in JSON format:


Retrieve the list of items in the "Briefcase" folder in XML format:


Retrieve the list of items in the "Briefcase" folder in RSS format:


Download all items in the "Briefcase" folder in a ZIP archive:


Retrieve the user-defined briefcase folder "MyBriefcaseFolder", in JSON format:


Retrieve the directory of a user-defined "TestFolder1" folder that is a sub-folder of "Briefcase":


Verified Against: Zimbra Collaboration Server 7.0 Date Created: 01/16/2010
Article ID: https://wiki.zimbra.com/index.php?title=Zimbra_REST_API_Reference:Get_Briefcase Date Modified: 2014-08-05

Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »

Jump to: navigation, search