Difference between revisions of "Zimbra REST API Reference:Get Contacts"

(Adding categories)
(URL)
Line 14: Line 14:
 
http://localhost:7070/home/john.doe/contacts?{params}
 
http://localhost:7070/home/john.doe/contacts?{params}
 
</pre>
 
</pre>
 +
 +
Go to [[ZCS_6.0:Zimbra_REST_API_Reference#Command_Format|Command Format]]
  
 
=== Formats ===
 
=== Formats ===

Revision as of 03:45, 11 February 2010

<< 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

GET

URL

http://localhost:7070/home/john.doe/contacts?{params}

Go to Command Format

Formats

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)

Parameters

  • 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:

http://localhost:7070/home/john.doe/contacts
http://localhost:7070/home/john.doe/contacts?fmt=csv

Retrieve the contacts in XML format:

http://localhost:7070/home/john.doe/contacts?fmt=xml

Retrieve the contacts in JSON format:

http://localhost:7070/home/john.doe/contacts?fmt=json

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

http://localhost:7070/home/john.doe/contacts?fmt=json&query=martha

Download the contacts as a ZIP file:

http://localhost:7070/home/john.doe/contacts?fmt=zip

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

http://localhost:7070/home/john.doe/contacts/mybusinescontacts?fmt=json

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

http://localhost:7070/home/john.doe/salescontacts?fmt=xml


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