Zimbra REST API Reference:Get Contacts

Revision as of 03:45, 11 February 2010 by Sposetti (talk | contribs) (→‎URL)
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

<< Back to Zimbra REST API Reference

REST API Method: Get Contacts

Gets the contacts in the designated folder. The default folder is "contacts" but user-defined folders are also supported.

HTTP Method




Go to Command Format


csv,json,xml,tgz,zip (Go to Response Formats)

Note: the ZIP format includes the contacts as individual vCard .vcf files

Requires Authentication

true (Go to Authentication)


  • fmt. Optional. The response format. Defaults to csv.
  • csvfmt. Optional. If format is csv, optionally select the CSV type which include:
    • zimbra-csv
    • yahoo-csv
    • thunderbird-csv
    • outlook-2000-csv
    • outlook-2003-csv
  • meta. Optional. If format is tar or tgz, optionally select the CSV type which include. Use meta=1 to include meta files, meta=0 to not include meta files. If omitted, defaults to meta=1.
  • query. Optional. A query string.

Usage Examples

Download the contacts as a CSV file:


Retrieve the contacts in XML format:


Retrieve the contacts in JSON format:


Retrieve the contacts with the string "martha" in JSON format:


Download the contacts as a ZIP file:


Retrieve the contacts from the used-defined folder "Contacts > MyBusinessContacts" as JSON format:


Retrieve the contacts from the used-defined folder "SalesContacts" as XML format:


Verified Against: Zimbra Collaboration Suite 6.0 Date Created: 01/16/2010
Article ID: https://wiki.zimbra.com/index.php?title=Zimbra_REST_API_Reference:Get_Contacts Date Modified: 2010-02-11

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