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

(Usage Examples)
(Remove old ZCS_6.0 prefixes)
 
(20 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[ZCS_6.0:Zimbra_REST_API_Reference|<< Back to Zimbra REST API Reference]]
+
{{Template:TabHeader}}
 +
{{Template:Tab2|[[Zimbra_REST_API_Reference|Introduction]]}}
 +
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Folder|Method: Get Folder]]}}
 +
{{Template:Tab2|[[Zimbra_REST_API_Reference:Import_Message|Method: Import Message]]}}
 +
{{Template:Tab1|[[Zimbra_REST_API_Reference:Get_Contacts|Method: Get Contacts]]}}
 +
{{Template:Tab2|[[Zimbra_REST_API_Reference:Import_Contacts|Method: Import Contacts]]}}
 +
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Calendar|Method: Get Calendar]]}}
 +
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_FreeBusy|Method: Get FreeBusy]]}}
 +
{{Template:Tab2|[[Zimbra_REST_API_Reference:Import_Appointments|Method: Import Appointments]]}}
 +
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Tasks|Method: Get Tasks]]}}
 +
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Item|Method: Get Item]]}}
 +
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Briefcase|Method: Get Briefcase]]}}
 +
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Briefcase_Item|Method: Get Briefcase Item]]}}
 +
{{Template:Tab2|[[Zimbra_REST_API_Reference:Export_Mailbox|Method: Export Mailbox]]}}
 +
{{Template:TabFooter}}
 +
 
 +
{{Article Infobox|{{devel}}|{{ZCS 8.0}}|{{ZCS 7.0}}|{{ZCS 6.0}}|}}[[ZCS_6.0:Zimbra_REST_API_Reference|<< Back to Zimbra REST API Reference]]
  
 
== REST API Method: Get Contacts ==
 
== REST API Method: Get Contacts ==
  
Gets the contacts not in the trash.
+
Gets the contacts in the designated folder. The default folder is "contacts" but user-defined folders are also supported.
  
 
=== URL ===
 
=== URL ===
Line 10: Line 26:
 
http://localhost:7070/home/john.doe/contacts?{params}
 
http://localhost:7070/home/john.doe/contacts?{params}
 
</pre>
 
</pre>
 +
 +
Go to [[ZCS_6.0:Zimbra_REST_API_Reference#Command_Format|Command Format]]
 +
 +
=== HTTP Method ===
 +
 +
<code>GET</code>
  
 
=== Formats ===
 
=== Formats ===
  
 
<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 ===
Line 22: Line 46:
  
 
<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 keyword.</li>
+
<li><code>csvfmt</code>. Optional. If format is <code>csv</code>, optionally select the CSV type which 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>
 +
<li><code>meta</code>. Optional. If format is <code>tar</code> or <code>tgz</code>, optionally select the CSV type which include. Use <code>meta=1</code> to include meta files, <code>meta=0</code> to not include meta files. If omitted, defaults to <code>meta=1</code>.</li>
 +
<li><code>query</code>. Optional. A query string.</li>
 
</ul>
 
</ul>
  
Line 46: Line 80:
 
</pre>
 
</pre>
  
Download the contacts as a ZIP file (the ZIP will contain the contacts vCard format <code>.vcf</code> files):
+
Retrieve the contacts with the string "martha" in JSON format:
 +
<pre>
 +
http://localhost:7070/home/john.doe/contacts?fmt=json&query=martha
 +
</pre>
 +
 
 +
Download the contacts as a ZIP file:
 
<pre>
 
<pre>
 
http://localhost:7070/home/john.doe/contacts?fmt=zip
 
http://localhost:7070/home/john.doe/contacts?fmt=zip
 
</pre>
 
</pre>
  
 +
Retrieve the contacts from the used-defined folder "Contacts > MyBusinessContacts" as JSON format:
 +
<pre>
 +
http://localhost:7070/home/john.doe/contacts/mybusinescontacts?fmt=json
 +
</pre>
 +
 +
Retrieve the contacts from the used-defined folder "SalesContacts" as XML format:
 +
<pre>
 +
http://localhost:7070/home/john.doe/salescontacts?fmt=xml
 +
</pre>
 +
 +
 +
 +
{{Article Footer|Zimbra Collaboration Server 7.0|01/16/2010}}
  
  
{{Article Footer|Zimbra Collaboration Suite 6.0|01/16/2010}}
+
[[Category:REST]]
 +
[[Category:ZCS 7.0]]
 +
[[Category:ZCS 6.0]]
 +
[[Category:Developers]]

Latest revision as of 17:22, 5 August 2014

Introduction  


Method: Get Folder  


Method: Import Message  


Method: Get Contacts  


Method: Import Contacts  


Method: Get Calendar  


Method: Get FreeBusy  


Method: Import Appointments  


Method: Get Tasks  


Method: Get Item  


Method: Get Briefcase  


Method: Get Briefcase Item  


Method: Export Mailbox  


 


Developer Article

Article Information

This article applies to the following ZCS versions.

ZCS 8.0 Article ZCS 8.0 ZCS 7.0 Article ZCS 7.0 ZCS 6.0 Article ZCS 6.0

<< Back to Zimbra REST API Reference

REST API Method: Get Contacts

Gets the contacts in the designated folder. The default folder is "contacts" but user-defined folders are also supported.

URL

http://localhost:7070/home/john.doe/contacts?{params}

Go to Command Format

HTTP Method

GET

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 to csv.
  • csvfmt. Optional. If format is csv, optionally select the CSV type which include:
    • zimbra-csv
    • yahoo-csv
    • thunderbird-csv
    • outlook-2000-csv
    • outlook-2003-csv
  • meta. Optional. If format is tar or tgz, optionally select the CSV type which include. Use meta=1 to include meta files, meta=0 to not include meta files. If omitted, defaults to meta=1.
  • query. Optional. A query string.

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

Retrieve the contacts with the string "martha" in JSON format:

http://localhost:7070/home/john.doe/contacts?fmt=json&query=martha

Download the contacts as a ZIP file:

http://localhost:7070/home/john.doe/contacts?fmt=zip

Retrieve the contacts from the used-defined folder "Contacts > MyBusinessContacts" as JSON format:

http://localhost:7070/home/john.doe/contacts/mybusinescontacts?fmt=json

Retrieve the contacts from the used-defined folder "SalesContacts" as XML format:

http://localhost:7070/home/john.doe/salescontacts?fmt=xml


Verified Against: Zimbra Collaboration Server 7.0 Date Created: 01/16/2010
Article ID: https://wiki.zimbra.com/index.php?title=Zimbra_REST_API_Reference:Get_Contacts Date Modified: 2014-08-05



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