Zimbra REST API: Task Methods | Zimbra

Document
Alert! This article is written for Zimbra OSE users. As of December 2023, Synacor will no longer be providing support for Zimbra OSE. You might want to consider trying out Carbonio Community Edition – Zextras’s free and open-source email and collaboration platform.

For additional guidance, check out our community articles detailing the process of migrating from your current platform to Carbonio CE.

For enterprise-level requirements and advanced features, consider checking out Zextras Carbonio – the all-in-one private digital workplace designed for digital sovereignty trusted by the public sector, telcos, and regulated industries.

In this article we are going to analyze the Task methods of the Zimbra REST API. For an overview and in-depth coverage about it, we refer you to the related article in our technical blog.

Get Tasks

This method retrieves tasks. The HTTP method to read data is get.

The basic URL structure is the following one:

http(s)://<host>/home/sample.user/tasks?{params}

Formats

The supported reply formats are ics, json, xml, rss, atom

Parameters

Both response format (fmt) and the query string (query) are optional

Examples

Below are two examples on how to retrieve tasks.

To download tasks in iCalendar format, the default one, you have two options. Leave the default command or specify the format:

https://mail.sampledomain.com/home/james.red/tasks

https://mail.sampledomain.com/home/james.red/tasks?fmt=ics

To retrieve data in JSON format:

https://mail.sampledomain.com/home/james.red/tasks?fmt=json

Download Zextras Suite for Zimbra OSE

Post your comment

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Zimbra REST API: Calendar Methods | Zimbra
Zimbra REST API: Item Methods | Zimbra