Zimbra REST API Reference:Get Contacts: Difference between revisions
(New page: << Back to Zimbra REST API Reference == REST API Method: Get Contacts == Gets the contacts not in the trash. === URL === <pre> http://localhost:70...) |
|||
Line 23: | Line 23: | ||
<ul> | <ul> | ||
<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 | <li><code>query</code>. Optional. A query keyword.</li> | ||
</ul> | </ul> | ||
Revision as of 20:49, 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
Retrieve the inbox folder in RSS format:
http://localhost:7070/home/john.doe/inbox?fmt=rss
Retrieve the inbox folder in XML format:
http://localhost:7070/home/john.doe/inbox?fmt=xml
Retrieve the drafts folder, query for keyword "automobile", in XML format:
http://localhost:7070/home/john.doe/drafts?fmt=xml&query=automobile
Retrieve the inbox folder, query for keywords "automobile" and "highway", in XML format:
http://localhost:7070/home/john.doe/inbox?fmt=xml&query=automobile+highway
Retrieve the inbox folder, query for phrase "new automobile", in XML format:
http://localhost:7070/home/john.doe/inbox?fmt=xml&query="new+automobile"
Retrieve the mycustomers folder, in JSON format:
http://localhost:7070/home/john.doe/mycustomers?fmt=json