Zimbra REST API Reference:Get Contacts: Difference between revisions
No edit summary |
|||
Line 26: | Line 26: | ||
<li><code>fmt</code>. Optional. The response format. Defaults to <code>csv</code></li> | <li><code>fmt</code>. Optional. The response format. Defaults to <code>csv</code></li> | ||
<li><code>query</code>. Optional. A query keyword.</li> | <li><code>query</code>. Optional. A query keyword.</li> | ||
<li><code>csvfmt</code>. Optional. The CSV type. Valid types include: | |||
<ul> | |||
<li>zimbra-csv</li> | |||
<li>yahoo-csv</li> | |||
<li>thunderbird-csv</li> | |||
<li>outlook-2000-csv</li> | |||
<li>outlook-2003-csv</li> | |||
</ul> | |||
</li> | |||
</ul> | </ul> | ||
Revision as of 22:26, 17 January 2010
<< Back to Zimbra REST API Reference
REST API Method: Get Contacts
Gets the contacts.
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.csvfmt
. Optional. The CSV type. Valid types include:- zimbra-csv
- yahoo-csv
- thunderbird-csv
- outlook-2000-csv
- outlook-2003-csv
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:
http://localhost:7070/home/john.doe/contacts?fmt=zip