Zimbra REST API: Task Methods

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

Technical writer at Zextras. Linux and technology enthusiast. He describes himself as an atypical and polyhedric IT expert, thanks to a creative and open minded attitude, and to the experience gained over time as an IT technician, system engineer and developer.

Post your comment