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

(Parameters)
(Usage Examples)
Line 28: Line 28:
 
=== Usage Examples ===
 
=== Usage Examples ===
  
Retrieve the inbox folder in RSS format:
+
Download the contacts as a CSV file:
 
<pre>
 
<pre>
http://localhost:7070/home/john.doe/inbox?fmt=rss
+
http://localhost:7070/home/john.doe/contacts
 
</pre>
 
</pre>
  
Retrieve the inbox folder in XML format:
+
Retrieve the contacts in XML format:
 
<pre>
 
<pre>
http://localhost:7070/home/john.doe/inbox?fmt=xml
+
http://localhost:7070/home/john.doe/contacts?fmt=xml
 
</pre>
 
</pre>
  
Retrieve the drafts folder, query for keyword "automobile", in XML format:
+
Retrieve the contacts in JSON format:
 
<pre>
 
<pre>
http://localhost:7070/home/john.doe/drafts?fmt=xml&query=automobile
+
http://localhost:7070/home/john.doe/contacts?fmt=json
 
</pre>
 
</pre>
  
Retrieve the inbox folder, query for keywords "automobile" and "highway", in XML format:
+
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/inbox?fmt=xml&query=automobile+highway
+
http://localhost:7070/home/john.doe/contacts?fmt=zip
</pre>
 
 
 
Retrieve the inbox folder, query for phrase "new automobile", in XML format:
 
<pre>
 
http://localhost:7070/home/john.doe/inbox?fmt=xml&query="new+automobile"
 
</pre>
 
 
 
Retrieve the mycustomers folder, in JSON format:
 
<pre>
 
http://localhost:7070/home/john.doe/mycustomers?fmt=json
 
 
</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 to csv
  • 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


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



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