Zimbra REST API Reference:Get Contacts: Difference between revisions
Line 28: | Line 28: | ||
=== Usage Examples === | === Usage Examples === | ||
Download the contacts as a CSV file: | |||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/ | http://localhost:7070/home/john.doe/contacts | ||
</pre> | </pre> | ||
Retrieve the | Retrieve the contacts in XML format: | ||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/ | http://localhost:7070/home/john.doe/contacts?fmt=xml | ||
</pre> | </pre> | ||
Retrieve the | Retrieve the contacts in JSON format: | ||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/ | http://localhost:7070/home/john.doe/contacts?fmt=json | ||
</pre> | </pre> | ||
Download the contacts as a ZIP file (the ZIP will contain the contacts vCard format <code>.vcf</code> files): | |||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/ | http://localhost:7070/home/john.doe/contacts?fmt=zip | ||
</pre> | </pre> | ||
Revision as of 20:51, 16 January 2010
<< Back to Zimbra REST API Reference
REST API Method: Get Contacts
Gets the contacts not in the trash.
URL
http://localhost:7070/home/john.doe/contacts?{params}
Formats
csv,json,xml,tgz,zip
(Go to Response Formats)
Requires Authentication
true
(Go to Authentication)
Parameters
fmt
. Optional. The response format. Defaults tocsv
query
. Optional. A query keyword.
Usage Examples
Download the contacts as a CSV file:
http://localhost:7070/home/john.doe/contacts
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
Download the contacts as a ZIP file (the ZIP will contain the contacts vCard format .vcf
files):
http://localhost:7070/home/john.doe/contacts?fmt=zip