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.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure China regions
Power Automate Standard All Power Automate regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Power Apps Standard All Power Apps regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Connector Metadata
Publisher Microsoft

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 connection10060 seconds
Frequency of trigger polls115 seconds

Actions

Complete a task

This operation marks the given task as complete.

Complete a task

Completes a task and sets the CompletedDateTime property to the current date, and Status property to Completed.

Create a task

This operation creates a new task in the default task folder (Tasks) in your mailbox.

Create a task (V2)

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

Create a task [DEPRECATED]

This action has been deprecated. Please use Create a task instead.

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

Create a task folder

This operation creates a new task folder in the default task group (My Tasks) in your mailbox.

Create a task folder

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

Create a task folder in a task group

This operation creates a new task folder in the specified task group in your mailbox.

Create a task group

This operation creates a new task group in your mailbox.

Create a task group

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

Create a task in folder

This operation creates a new task in the specified task folder in your mailbox.

Delete a task

This operation will delete an existing task.

Get a task

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

Get a task

This operation gets a specific task.

Get a task folder

This operation gets a specific task folder.

Get a task group

This operation gets a specific task group.

List all task folders

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

List all task groups

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

List all task groups

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

List all tasks

Returns a list of all your tasks in your mailbox.

List all tasks

This operation returns a list of all your tasks.

List task folders in group

Returns a list of all the task folders in the specified task group in your mailbox.

List task folders in group

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

List tasks in folder

Returns a list of all your tasks in the specified task folder in your mailbox.

List tasks in folder

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

Mark a task as incomplete

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

Update a task

This operation is used to modify an existing task.

Update a task folder

This operation is used to modify an existing task folder.

Update a task group

This operation is used to modify an existing task group.

Complete a task

This operation marks the given task as complete.

Parameters

Name Key Required Type Description
Task
taskId True string

Unique id of the task to complete.

Returns

An Outlook task object.

Body
Task

Complete a task

Completes a task and sets the CompletedDateTime property to the current date, and Status property to Completed.

Parameters

Name Key Required Type Description
Task ID
task_id True string

The programatic task ID, unique in the user's mailbox.

Returns

Name Path Type Description
An array containing the single Task that was completed.
value array of TaskOS

Create a task

This operation creates a new task in the default task folder (Tasks) in your mailbox.

Parameters

Name Key Required Type Description
Status
Status string

Indicates state or progress of the task.

Subject
Subject True string

Brief description or title of the task.

Html
Content html

The HTML content for the body of the task.

Category
Categories string

Associated with the task.

Importance
Importance string

The importance of this task.

Sensitivity
Sensitivity string

Indicates the level of privacy for this task.

Date
DateTime True date

Format: YYYY-MM-DD.

Time Zone
TimeZone True string

Time zone to use for the DateTime field.

Date
DateTime True date

Format: YYYY-MM-DD.

Time Zone
TimeZone True string

Time zone to use for the DateTime field.

Date
DateTime True date

Format: YYYY-MM-DD.

Time Zone
TimeZone True string

Time zone to use for the DateTime field.

Is reminder on
IsReminderOn boolean

True if an alert is set to remind the user of the task.

Date & Time
DateTime string

Format: YYYY-MM-DDThh:mm:ss.

Time Zone
TimeZone string

Time zone to use for the DateTime field.

Create a task (V2)

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

Parameters

Name Key Required Type Description
Folder Id
folderId string

Pick a task folder.

Due Date
DateTime date-time

YYYY-MM-DD or YYYY-MM-DDThh:mm:ssZ (note the time portion will be ignored).

Reminder Date-Time
DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

Start Date
DateTime date-time

YYYY-MM-DD or YYYY-MM-DDThh:mm:ssZ (note the time portion will be ignored).

Importance
Importance string

Low, normal or high.

Subject
Subject True string

Brief description or title of the task.

Status
Status string

Indicates state or progress of the task - not started, in progress, completed, waiting on others or deferred.

Sensitivity
Sensitivity string

Indicates the level of privacy for the event.

Content
Content html

The content.

Category
Categories string

Associated with the task.

Is Reminder On
IsReminderOn boolean

True if an alert is set to remind the user of the task.

Returns

An Outlook task object.

Body
TaskHTML

Create a task [DEPRECATED]

This action has been deprecated. Please use Create a task instead.

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

Parameters

Name Key Required Type Description
Folder Id
folderId string

Pick a task folder.

Due Date
DateTime date-time

YYYY-MM-DD or YYYY-MM-DDThh:mm:ssZ (note the time portion will be ignored).

Reminder Date-Time
DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

Start Date
DateTime date-time

YYYY-MM-DD or YYYY-MM-DDThh:mm:ssZ (note the time portion will be ignored).

Importance
Importance string

Low, normal or high.

Subject
Subject True string

Brief description or title of the task.

Status
Status string

Indicates state or progress of the task - not started, in progress, completed, waiting on others or deferred.

Sensitivity
Sensitivity string

Indicates the level of privacy for the event.

Content Type
ContentType string

The content type of the body. Text or HTML.

Content
Content string

The text or HTML content.

Category
Categories string

Associated with the task.

Is Reminder On
IsReminderOn boolean

True if an alert is set to remind the user of the task.

Returns

An Outlook task object.

Body
Task

Create a task folder

This operation creates a new task folder in the default task group (My Tasks) in your mailbox.

Parameters

Name Key Required Type Description
Id
Id string

Unique identifier of the task folder.

Name
Name True string

Name of the task folder.

Is Default
IsDefaultFolder boolean

True if this is the default task folder.

Create a task folder

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

Parameters

Name Key Required Type Description
Task group
groupId string

Group id for your task group.

Id
Id string

Unique identifier of the task folder.

Name
Name True string

Name of the task folder.

Is Default
IsDefaultFolder boolean

True if this is the default task folder.

Returns

An Outlook task folder.

Body
TaskFolder

Create a task folder in a task group

This operation creates a new task folder in the specified task group in your mailbox.

Parameters

Name Key Required Type Description
Task Group ID
group_id True string

The programatic ID of a task group, unique in the user's mailbox.

Id
Id string

Unique identifier of the task folder.

Name
Name True string

Name of the task folder.

Is Default
IsDefaultFolder boolean

True if this is the default task folder.

Create a task group

This operation creates a new task group in your mailbox.

Parameters

Name Key Required Type Description
Id
Id string

Unique identifier of the task group.

Name
Name True string

Name of the task group.

Is Default
IsDefaultGroup boolean

True if default task group.

Create a task group

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

Parameters

Name Key Required Type Description
Id
Id string

Unique identifier of the task group.

Name
Name True string

Name of the task group.

Is Default
IsDefaultGroup boolean

True if default task group.

Returns

An Outlook task group.

Body
TaskGroup

Create a task in folder

This operation creates a new task in the specified task folder in your mailbox.

Parameters

Name Key Required Type Description
Task Folder ID
folder_id True string

The default 'Tasks' well-known folder name, or a programatic ID of a task folder, unique in the user's mailbox.

Status
Status string

Indicates state or progress of the task.

Subject
Subject True string

Brief description or title of the task.

Html
Content html

The HTML content for the body of the task.

Category
Categories string

Associated with the task.

Importance
Importance string

The importance of this task.

Sensitivity
Sensitivity string

Indicates the level of privacy for this task.

Date
DateTime True date

Format: YYYY-MM-DD.

Time Zone
TimeZone True string

Time zone to use for the DateTime field.

Date
DateTime True date

Format: YYYY-MM-DD.

Time Zone
TimeZone True string

Time zone to use for the DateTime field.

Date
DateTime True date

Format: YYYY-MM-DD.

Time Zone
TimeZone True string

Time zone to use for the DateTime field.

Is reminder on
IsReminderOn boolean

True if an alert is set to remind the user of the task.

Date & Time
DateTime string

Format: YYYY-MM-DDThh:mm:ss.

Time Zone
TimeZone string

Time zone to use for the DateTime field.

Delete a task

This operation will delete an existing task.

Parameters

Name Key Required Type Description
Task ID
task_id True string

The programatic task ID, unique in the user's mailbox.

Get a task

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

Parameters

Name Key Required Type Description
Task Id
taskId True string

Unique id of the task.

Returns

An Outlook task object.

Body
Task

Get a task

This operation gets a specific task.

Parameters

Name Key Required Type Description
Task ID
task_id True string

The programatic task ID, unique in the user's mailbox.

Get a task folder

This operation gets a specific task folder.

Parameters

Name Key Required Type Description
Task Folder ID
folder_id True string

The default 'Tasks' well-known folder name, or a programatic ID of a task folder, unique in the user's mailbox.

Get a task group

This operation gets a specific task group.

Parameters

Name Key Required Type Description
Task Group ID
group_id True string

The programatic ID of a task group, unique in the user's mailbox.

List all task folders

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

Parameters

Name Key Required Type Description
Filter Items
$filter string

OData $filter. e.g. contains(Name, 'custom'). Filterable properties: Name.

Top Items
$top integer

The number of items in the queried collection to be included in the result.

Skip Items
$skip integer

The number of items in the queried collection that are to be skipped and not included in the result. This is applied before the $top option.

List all task groups

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

Parameters

Name Key Required Type Description
Filter Items
$filter string

OData $filter. e.g. contains(Name, 'custom'). Filterable properties: Name.

Top Items
$top integer

The number of items in the queried collection to be included in the result.

Skip Items
$skip integer

The number of items in the queried collection that are to be skipped and not included in the result. This is applied before the $top option.

List all task groups

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

Returns

List all tasks

Returns a list of all your tasks in your mailbox.

Parameters

Name Key Required Type Description
Filter Items
$filter string

OData $filter. e.g. To return only incomplete tasks: Status ne 'Completed'. e.g. Search by subject: contains(Subject, 'some text'). e.g. Return tasks that have been modified after a certain date: LastModifiedDateTime gt 2020-03-27T19:00:00z. Common filterable properties: Subject, Status, Categories, Importance, Sensitivity, CreatedDateTime, LastModifiedDateTime, StartDateTime, DueDateTime, CompletedDateTime, HasAttachments.

Top Items
$top integer

The number of items in the queried collection to be included in the result.

Skip Items
$skip integer

The number of items in the queried collection that are to be skipped and not included in the result. This is applied before the $top option.

List all tasks

This operation returns a list of all your tasks.

Returns

response
array of Task

List task folders in group

Returns a list of all the task folders in the specified task group in your mailbox.

Parameters

Name Key Required Type Description
Task Group ID
group_id True string

The programatic ID of a task group, unique in the user's mailbox.

Filter Items
$filter string

OData $filter. e.g. contains(Name, 'custom'). Filterable properties: Name.

Top Items
$top integer

The number of items in the queried collection to be included in the result.

Skip Items
$skip integer

The number of items in the queried collection that are to be skipped and not included in the result. This is applied before the $top option.

List task folders in group

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

Parameters

Name Key Required Type Description
Task group
groupId True string

Pick a task group.

Returns

List tasks in folder

Returns a list of all your tasks in the specified task folder in your mailbox.

Parameters

Name Key Required Type Description
Task Folder ID
folder_id True string

The default 'Tasks' well-known folder name, or a programatic ID of a task folder, unique in the user's mailbox.

Filter Items
$filter string

OData $filter. e.g. To return only incomplete tasks: Status ne 'Completed'. e.g. Search by subject: contains(Subject, 'some text'). e.g. Return tasks that have been modified after a certain date: LastModifiedDateTime gt 2020-03-27T19:00:00z. Common filterable properties: Subject, Status, Categories, Importance, Sensitivity, CreatedDateTime, LastModifiedDateTime, StartDateTime, DueDateTime, CompletedDateTime, HasAttachments.

Top Items
$top integer

The number of items in the queried collection to be included in the result.

Skip Items
$skip integer

The number of items in the queried collection that are to be skipped and not included in the result. This is applied before the $top option.

List tasks in folder

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

Parameters

Name Key Required Type Description
Task group
groupId True string

Pick a task group.

Task folder
folderId True string

Pick a task folder.

Returns

response
array of Task

Mark a task as incomplete

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

Parameters

Name Key Required Type Description
Task
taskId True string

Unique id of the task.

Status
Status string
Completed Date-Time
DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

Returns

An Outlook task object.

Body
Task

Update a task

This operation is used to modify an existing task.

Parameters

Name Key Required Type Description
Task ID
task_id True string

The programatic task ID, unique in the user's mailbox.

Status
Status string

Indicates state or progress of the task.

Subject
Subject string

Brief description or title of the task.

Html
Content html

The HTML content for the body of the task.

Category
Categories string

Associated with the task.

Importance
Importance string

The importance of this task.

Sensitivity
Sensitivity string

Indicates the level of privacy for this task.

Date
DateTime True date

Format: YYYY-MM-DD.

Time Zone
TimeZone True string

Time zone to use for the DateTime field.

Date
DateTime True date

Format: YYYY-MM-DD.

Time Zone
TimeZone True string

Time zone to use for the DateTime field.

Date
DateTime True date

Format: YYYY-MM-DD.

Time Zone
TimeZone True string

Time zone to use for the DateTime field.

Is reminder on
IsReminderOn boolean

True if an alert is set to remind the user of the task.

Date & Time
DateTime string

Format: YYYY-MM-DDThh:mm:ss.

Time Zone
TimeZone string

Time zone to use for the DateTime field.

Update a task folder

This operation is used to modify an existing task folder.

Parameters

Name Key Required Type Description
Task Folder ID
folder_id True string

The default 'Tasks' well-known folder name, or a programatic ID of a task folder, unique in the user's mailbox.

Id
Id string

Unique identifier of the task folder.

Name
Name True string

Name of the task folder.

Is Default
IsDefaultFolder boolean

True if this is the default task folder.

Update a task group

This operation is used to modify an existing task group.

Parameters

Name Key Required Type Description
Task Group ID
group_id True string

The programatic ID of a task group, unique in the user's mailbox.

Id
Id string

Unique identifier of the task group.

Name
Name True string

Name of the task group.

Is Default
IsDefaultGroup boolean

True if default task group.

Triggers

When a task is added

This operation triggers when a new task is created.

When a task is completed

This operation triggers when a task is marked as complete.

When a task is added

This operation triggers when a new task is created.

Parameters

Name Key Required Type Description
Folder
folderId string

Pick the folder to track for new tasks.

Returns

An Outlook task object.

Body
Task

When a task is completed

This operation triggers when a task is marked as complete.

Parameters

Name Key Required Type Description
Task
taskId True string

Unique id of the task to track.

Returns

An Outlook task object.

Body
Task

Definitions

TaskFolder

An Outlook task folder.

Name Path Type Description
Id
Id string

Unique identifier of the task folder.

Name
Name string

Name of the task folder.

Is Default
IsDefaultFolder boolean

True if this is the default task folder.

TaskGroup

An Outlook task group.

Name Path Type Description
Id
Id string

Unique identifier of the task group.

Name
Name string

Name of the task group.

Is Default
IsDefaultGroup boolean

True if default task group.

TaskOS

An Outlook task object.

Name Path Type Description
Id
Id string

Unique identifier of the task.

Parent Folder Id
ParentFolderId string

The unique id of the folder in which this task is located.

Assigned To
AssignedTo string

Name of the person who has been assigned the task.

Owner
Owner string

Name of the person who created the task.

Created
CreatedDateTime date-time

The date and time when the task was created.

Last Modified Date-Time
LastModifiedDateTime date-time

The date and time when this task was last modified.

Has attachments
HasAttachments boolean

True if this task has attachments.

Status
Status TaskOS-Status

Indicates state or progress of the task.

Subject
Subject TaskOS-Subject

Brief description or title of the task.

Content Type
Body.ContentType string

The format of the Content field. Usually it is HTML, but may be Text when no body was yet specified for this task.

Content
Body.Content string

The text or HTML content.

Categories
Categories TaskOS-Categories

Collection of category names associated with the task.

Importance
Importance TaskOS-Importance

The importance of this task.

Sensitivity
Sensitivity TaskOS-Sensitivity

Indicates the level of privacy for this task.

Date
StartDateTime.DateTime string

Format: YYYY-MM-DD.

Time Zone
StartDateTime.TimeZone DateTimeTimeZone-TimeZone

The time zone in which the DateTime field is expressed.

Date
DueDateTime.DateTime string

Format: YYYY-MM-DD.

Time Zone
DueDateTime.TimeZone DateTimeTimeZone-TimeZone

The time zone in which the DateTime field is expressed.

Date & Time
CompletedDateTime.DateTime string

UTC Format: YYYY-MM-DDThh:mm:ssZ.

Time Zone
CompletedDateTime.TimeZone DateTimeTimeZone-TimeZone

The time zone in which the DateTime field is expressed.

Is reminder on
IsReminderOn TaskOS-IsReminderOn

True if an alert is set to remind the user of the task.

Date & Time
ReminderDateTime.DateTime string

UTC Format: YYYY-MM-DDThh:mm:ssZ.

Time Zone
ReminderDateTime.TimeZone DateTimeTimeZone-TimeZone

The time zone in which the DateTime field is expressed.

TaskOS-Status

Indicates state or progress of the task.

Indicates state or progress of the task.

Status
string

TaskOS-Subject

Brief description or title of the task.

Brief description or title of the task.

Subject
string

TaskOS-Categories

Collection of category names associated with the task.

Name Path Type Description
Category
string

Associated with the task.

TaskOS-Importance

The importance of this task.

The importance of this task.

Importance
string

TaskOS-Sensitivity

Indicates the level of privacy for this task.

Indicates the level of privacy for this task.

Sensitivity
string

TaskOS-IsReminderOn

True if an alert is set to remind the user of the task.

True if an alert is set to remind the user of the task.

Is reminder on
boolean

DateTimeTimeZone-TimeZone

The time zone in which the DateTime field is expressed.

The time zone in which the DateTime field is expressed.

Time Zone
string

Task

An Outlook task object.

Name Path Type Description
Id
Id string

Unique identifier of the task.

Created Date-Time
CreatedDateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

Modified Date-Time
LastModifiedDateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

Categories
Categories array of string

Collection of category names associated with the task.

Assigned To
AssignedTo string

Name of the person who has been assigned the task.

Content Type
Body.ContentType string

The content type of the body. Text or HTML.

Content
Body.Content string

The text or HTML content.

Date-Time
CompletedDateTime.DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

Date
DueDateTime.DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

Importance
Importance string

Low, normal or high.

Is reminder on
IsReminderOn boolean

True if an alert is set to remind the user of the task.

Owner
Owner string

Name of the person who created the task.

Date-Time
ReminderDateTime.DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

Date
StartDateTime.DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

Status
Status string

Indicates state or progress of the task - not started, in progress, completed, waiting on others or deferred.

Subject
Subject string

Brief description or title of the task.

TaskHTML

An Outlook task object.

Name Path Type Description
Id
Id string

Unique identifier of the task.

Created Date-Time
CreatedDateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

Modified Date-Time
LastModifiedDateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

Categories
Categories array of string

Collection of category names associated with the task.

Assigned To
AssignedTo string

Name of the person who has been assigned the task.

Content
Body.Content html

The content.

Date-Time
CompletedDateTime.DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

Date
DueDateTime.DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

Importance
Importance string

Low, normal or high.

Is reminder on
IsReminderOn boolean

True if an alert is set to remind the user of the task.

Owner
Owner string

Name of the person who created the task.

Date-Time
ReminderDateTime.DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

Date
StartDateTime.DateTime date-time

YYYY-MM-DDThh:mm:ssZ (UTC format).

Status
Status string

Indicates state or progress of the task - not started, in progress, completed, waiting on others or deferred.

Subject
Subject string

Brief description or title of the task.