Zimbra REST API Reference:Get Contacts: Difference between revisions
Line 14: | Line 14: | ||
<code>csv,json,xml,tgz,zip</code> ([[ZCS_6.0:Zimbra_REST_API_Reference#Response_Formats|Go to Response Formats]]) | <code>csv,json,xml,tgz,zip</code> ([[ZCS_6.0:Zimbra_REST_API_Reference#Response_Formats|Go to Response Formats]]) | ||
Note: the ZIP format includes the contacts as individual vCard <code>.vcf</code> files | |||
=== Requires Authentication === | === Requires Authentication === |
Revision as of 20:58, 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)
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 tocsv
query
. Optional. A query keyword.
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
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