Outlook Tasks

Outlook Tasks

Outlook Tasks service lets you create, read, synchronize, update and delete your tasks that are secured by Azure Active Directory in Office 365 or a Microsoft account.

Note that this integration requires permission to access resources within your AAD tenant. If you see an error trying to connect, check with your AAD admin to ensure the AAD application is approved within your tenant. More information on AAD consent can be found here.

You're now ready to start using this integration.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds
Frequency of trigger polls 1 15 seconds

Actions

Complete a task

This operation marks the given task as complete.

Required Parameters

Task
string
Unique id of the task to complete.

Returns

Body
Task

Details of the completed task.

Create a task

This operation is used to create a task in the specified task folder (defaults to My Tasks).

Required Parameters

Subject
string
Brief description or title of the task.

Optional Parameters

Folder Id
string
Folder
Due Date
date-time
YYYY-MM-DD or YYYY-MM-DDThh:mm:ssZ (note the time portion will be ignored)
Reminder Date-Time
date-time
YYYY-MM-DDThh:mm:ssZ (UTC format)
Start Date
date-time
YYYY-MM-DD or YYYY-MM-DDThh:mm:ssZ (note the time portion will be ignored)
Importance
string
Low, normal or high.
Status
string
Indicates state or progress of the task - not started, in progress, completed, waiting on others or deferred.
Sensitivity
string
Indicates the level of privacy for the event.
Content Type
string
Text=0, HTML=1
Content
string
The text or HTML content.
Category
string
Associated with the task.
Is Reminder On
boolean
True if an alert is set to remind the user of the task.

Returns

Body
Task

Details of the newly created task.

Create a task folder

This operation creates a new folder. Optionally, you may choose to put the new folder in an existing task group.

Required Parameters

Folder name
string
Name of the task folder

Optional Parameters

Task group
string
Group id for your task group.

Returns

Body
TaskFolder

Details of the newly created task folder.

Create a task group

This operation is used to create a new task group in your mailbox.

Required Parameters

Name
string
Ttile of the task group.

Returns

Body
TaskGroup

Details of the newly created task group.

Get task

This operation is used to retrieve the details of a task by its id.

Required Parameters

Task Id
string
Unique id of the task.

Returns

Body
Task

Details of the task.

Get task folders in group

Returns a list of task folders in the given task group.

Required Parameters

Task group
string
Task group

Returns

array of TaskFolder

List all task groups

Returns a list of all the task groups in your mailbox.

Required Parameters

Task
string
Unique id of the task to complete.

Returns

array of TaskGroup

List all tasks

This operation returns a list of all your tasks.

Required Parameters

Task
string
Unique id of the task to complete.

Returns

array of Task

List all tasks in folder

This operation returns a list of all tasks in a given folder.

Required Parameters

Task group
string
Pick a task group.
Task folder
string
Pick a task folder.

Returns

array of Task

Mark a task as incomplete

This operation is used to mark the given task as incomplete.

Required Parameters

Task
string
Unique id of the task.

Optional Parameters

Status
string
Completed Date-Time
date-time
YYYY-MM-DDThh:mm:ssZ (UTC format)

Returns

Body
Task

Details of the task.

Triggers

When a task is added

This operation triggers when a new task is created.

Optional Parameters

Folder
string
Pick the folder to track for new tasks.

Returns

Body
Task

An Outlook task object.

When a task is completed

This operation triggers when a task is marked as complete.

Required Parameters

Task
string
Unique id of the task to track.

Returns

Body
Task

Details of the newly created task.

Definitions

TaskGroup

Is Default
boolean
True if default task group.
Name
string
Name of the task group.

Task

An Outlook task object.

Assigned To
string
Name of the person who has been assigned the task.
Categories
array of string
Collection of category names associated with the task.
Content
string
The text or HTML content.
Content Type
string
Text=0, HTML=1
Created Date-Time
date-time
YYYY-MM-DDThh:mm:ssZ (UTC format)
Date
date-time
YYYY-MM-DDThh:mm:ssZ (UTC format)
Date
date-time
YYYY-MM-DDThh:mm:ssZ (UTC format)
Date-Time
date-time
YYYY-MM-DDThh:mm:ssZ (UTC format)
Date-Time
date-time
YYYY-MM-DDThh:mm:ssZ (UTC format)
Id
string
Unique identifier of the task.
Importance
string
Low, normal or high.
Is reminder on
boolean
True if an alert is set to remind the user of the task.
Modified Date-Time
date-time
YYYY-MM-DDThh:mm:ssZ (UTC format)
Owner
string
Name of the person who created the task.
Status
string
Indicates state or progress of the task - not started, in progress, completed, waiting on others or deferred.
Subject
string
Brief description or title of the task.

TaskFolder

An Outlook task folder.

Id
string
Unique identifier of the task folder.
Is Default
boolean
True if this is the default task folder.
Name
string
Name of the task folder.