Planner

Microsoft Planner lets you easily bring together teams, tasks, documents, and conversations for better results.

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
Flow Standard All Flow regions
PowerApps Standard All PowerApps regions

For more information, please refer to Planner API Docs

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds
Frequency of trigger polls160 seconds

Actions

Create a bucket

Create a bucket in planner for the specified plan and group.

Create a bucket [DEPRECATED]

Create a bucket in planner.

Create a task

Create a new task in planner.

Create a task [DEPRECATED]

Create a new task in planner.

Create a task [DEPRECATED]

Create a new task in planner.

Get a task

Get an existing planner task.

Get a task [DEPRECATED]

Get an existing planner task.

Get task details

Get the task details for an existing task.

Get task details [DEPRECATED]

Get the task details for an existing task.

List buckets

List the buckets in a plan.

List buckets [DEPRECATED]

List the buckets in a plan.

List buckets [DEPRECATED]

List the buckets in a plan.

List my plans [DEPRECATED]

List the plans the user has subscribed to.

List my plans [DEPRECATED]

List the plans the user has subscribed to.

List my tasks

List the tasks assigned to me.

List my tasks [DEPRECATED]

List the tasks assigned to me.

List plans for a group

List plans owned by the group specified.

List tasks

List the tasks in a plan.

List tasks [DEPRECATED]

List the tasks in a plan.

List tasks [DEPRECATED]

List the tasks in a plan.

Update a task

Update an existing planner task.

Update a task [DEPRECATED]

Update an existing planner task.

Update task details

Update the task details for an existing task.

Update task details [DEPRECATED]

Update the task details for an existing task.

Create a bucket

Create a bucket in planner for the specified plan and group.

Parameters

Name Key Required Type Description
Name
name True string

Name of the bucket

Group Id
groupId True string

The group to retrieve the plan.

Plan Id
planId True string

The plan for the new bucket.

Returns

Create a bucket [DEPRECATED]

Create a bucket in planner.

Parameters

Name Key Required Type Description
Name
name True string

Name of the bucket

Plan Id
planId True string

The plan for the new bucket

Returns

Create a task

Create a new task in planner.

Parameters

Name Key Required Type Description
Group Id
groupId True string

The group to retrieve the plan.

Plan Id
planId True string

The plan for the new task.

Title
title True string

The title of the new task.

Bucket Id
bucketId string

The bucket to place this task in.

Start Date Time
startDateTime date-time

The datetime the task starts (Ex. '2018-04-13T00:42:19.284Z').

Due Date Time
dueDateTime date-time

The datetime the task is due (Ex. '2018-04-13T00:42:19.284Z').

Assigned User Ids
assignments string

Semi-colon seperated ids or email addresses of users to assign this task to.

Returns

Create a task [DEPRECATED]

Create a new task in planner.

Parameters

Name Key Required Type Description
Plan Id
planId True string

The plan for the new task.

Title
title True string

The title of the new task.

Bucket Id
bucketId string

The bucket to place this task in.

Start Date Time
startDateTime date-time

The datetime the task starts (Ex. '2018-04-13T00:42:19.284Z').

Due Date Time
dueDateTime date-time

The datetime the task is due (Ex. '2018-04-13T00:42:19.284Z').

Assigned User Ids
assignments string

Semi-colon seperated ids or email addresses of users to assign this task to.

Returns

Create a task [DEPRECATED]

Create a new task in planner.

Parameters

Name Key Required Type Description
Plan Id
planId True string

The plan for the new task.

Title
title True string

The title of the new task.

Bucket Id
bucketId string

The bucket to place this task in.

Start Date Time
startDateTime date-time

The datetime the task starts (Ex. '2018-04-13T00:42:19.284Z').

Due Date Time
dueDateTime date-time

The datetime the task is due (Ex. '2018-04-13T00:42:19.284Z').

Assigned User Id
assignments string

The id or email address of the user to assign this task to.

Returns

Get a task

Get an existing planner task.

Parameters

Name Key Required Type Description
Task Id
id True string

The unique identifer of the task.

Returns

Get a task [DEPRECATED]

Get an existing planner task.

Parameters

Name Key Required Type Description
Task Id
id True string

The unique identifer of the task.

Returns

Get task details

Get the task details for an existing task.

Parameters

Name Key Required Type Description
Task Id
id True string

The unique identifer of the task.

Returns

Get task details [DEPRECATED]

Get the task details for an existing task.

Parameters

Name Key Required Type Description
Task Id
id True string

The unique identifer of the task.

Returns

List buckets

List the buckets in a plan.

Parameters

Name Key Required Type Description
Group Id
groupId True string

The group to retrieve the plan.

Plan Id
id True string

The unique identifier of the plan.

Returns

List buckets [DEPRECATED]

List the buckets in a plan.

Parameters

Name Key Required Type Description
Plan Id
id True string

The unique identifier of the plan.

Returns

List buckets [DEPRECATED]

List the buckets in a plan.

Parameters

Name Key Required Type Description
Plan Id
id True string

The unique identifier of the plan.

Returns

List my plans [DEPRECATED]

List the plans the user has subscribed to.

Returns

List my plans [DEPRECATED]

List the plans the user has subscribed to.

Returns

List my tasks

List the tasks assigned to me.

Returns

List my tasks [DEPRECATED]

List the tasks assigned to me.

Returns

List plans for a group

List plans owned by the group specified.

Parameters

Name Key Required Type Description
Group Id
groupId True string

Id of the group.

Returns

List tasks

List the tasks in a plan.

Parameters

Name Key Required Type Description
Group Id
groupId True string

The group to retrieve the plan.

Plan Id
id True string

The unique identifier of the plan.

Returns

List tasks [DEPRECATED]

List the tasks in a plan.

Parameters

Name Key Required Type Description
Plan Id
id True string

The unique identifier of the plan.

Returns

List tasks [DEPRECATED]

List the tasks in a plan.

Parameters

Name Key Required Type Description
Plan Id
id True string

The unique identifier of the plan.

Returns

Update a task

Update an existing planner task.

Parameters

Name Key Required Type Description
Task Id
id True string

The unique identifier of the task to update.

Title
title string

The title of the plan.

Due Date-Time
dueDateTime date-time

The datetime the task is due (Ex. '2018-04-13T00:42:19.284Z').

Start Date-Time
startDateTime date-time

The datetime the task starts (Ex. '2018-04-13T00:42:19.284Z').

Progress
percentComplete string

The progress of the task.

Add assigned users
assignments string

Semi-colon seperated ids or email addresses of users who should be assigned to this task.

Remove assigned users
unassignedUsers string

Semi-colon seperated ids or email addresses of users who should be unassigned from this task.

Returns

Update a task [DEPRECATED]

Update an existing planner task.

Parameters

Name Key Required Type Description
Task Id
id True string

The unique identifier of the tast to update.

Title
title string

The title of the plan.

Due Date-Time
dueDateTime date-time

The datetime the task is due (Ex. '2018-04-13T00:42:19.284Z').

Start Date-Time
startDateTime date-time

The datetime the task starts (Ex. '2018-04-13T00:42:19.284Z').

Progress
percentComplete string

The progress of the task.

Assisgned User Id
assignments string

The id or email address of the user to assign this task to.

Returns

Update task details

Update the task details for an existing task.

Parameters

Name Key Required Type Description
Task Id
id True string

The unique identifer of the task.

Description
description string

The description of the task.

Alias
alias string

A name alias to describe the reference.

Resource link
resourceLink uri

A valid URL based on the HTTP/HTTPS protocols.

Type of the reference
type

Used to describe the type of the reference.

Returns

Update task details [DEPRECATED]

Update the task details for an existing task.

Parameters

Name Key Required Type Description
Task Id
id True string

The unique identifer of the task.

Description
description string

The description of the task.

Alias
alias string

A name alias to describe the reference.

Resource link
resourceLink uri

A valid URL based on the HTTP/HTTPS protocols.

Type of the reference
type

Used to describe the type of the reference.

Returns

Triggers

When a new task is created

This operation triggers when a new task is created.

When a new task is created [DEPRECATED]

This operation triggers when a new task is created.

When a new task is created [DEPRECATED]

This operation triggers when a new task is created.

When a task is assigned to me

This operation triggers when a task is assigned to me.

When a task is assigned to me [DEPRECATED]

This operation triggers when a task is assigned to me.

When a task is completed

This operation triggers when a task is completed.

When a task is completed [DEPRECATED]

This operation triggers when a task is completed.

When a task is completed [DEPRECATED]

This operation triggers when a task is completed.

When a new task is created

This operation triggers when a new task is created.

Parameters

Name Key Required Type Description
Group Id
groupId True string

The group to retrieve the plan.

Plan Id
id True string

The unique identifier of the plan.

Returns

When a new task is created [DEPRECATED]

This operation triggers when a new task is created.

Parameters

Name Key Required Type Description
Plan Id
id True string

The unique identifier of the plan.

Returns

When a new task is created [DEPRECATED]

This operation triggers when a new task is created.

Parameters

Name Key Required Type Description
Plan Id
id True string

The unique identifier of the plan.

Returns

When a task is assigned to me

This operation triggers when a task is assigned to me.

Returns

When a task is assigned to me [DEPRECATED]

This operation triggers when a task is assigned to me.

Returns

When a task is completed

This operation triggers when a task is completed.

Parameters

Name Key Required Type Description
Group Id
groupId True string

The group to retrieve the plan.

Plan Id
id True string

The unique identifier of the plan.

Returns

When a task is completed [DEPRECATED]

This operation triggers when a task is completed.

Parameters

Name Key Required Type Description
Plan Id
id True string

The unique identifier of the plan.

Returns

When a task is completed [DEPRECATED]

This operation triggers when a task is completed.

Parameters

Name Key Required Type Description
Plan Id
id True string

The unique identifier of the plan.

Returns

Definitions

GetTask_Response

Name Path Type Description
Display Name
createdBy.user.displayName string

The display name of the user who created this task.

Id
createdBy.user.id string

The id of the user who created this task.

Plan Id
planId string

The id of the plan this task belongs to.

Bucket Id
bucketId string

The id of the bucket this task belongs to.

Title
title string

The title of the task.

Percent Complete
percentComplete integer

The completion percentage of the task.

Start Date Time
startDateTime date-time

The start datetime of the task.

Created Date Time
createdDateTime date-time

The datetime the task was created.

Due Date Time
dueDateTime date-time

The datetime the task is due.

Has Description
hasDescription boolean

Set to true if the task has a description.

Completed Date Time
completedDateTime date-time

The datetime the task was completed.

Reference Count
referenceCount integer

The number of external references that exist on the task.

Id
id string

The id of the task.

GetTask_Response_V2

Name Path Type Description
Display Name
createdBy.user.displayName string

The display name of the user who created this task.

Id
createdBy.user.id string

The id of the user who created this task.

Plan Id
planId string

The id of the plan this task belongs to.

Bucket Id
bucketId string

The id of the bucket this task belongs to.

Title
title string

The title of the task.

Percent Complete
percentComplete integer

The completion percentage of the task.

Start Date Time
startDateTime date-time

The start datetime of the task.

Created Date Time
createdDateTime date-time

The datetime the task was created.

Due Date Time
dueDateTime date-time

The datetime the task is due.

Has Description
hasDescription boolean

Set to true if the task has a description.

Completed Date Time
completedDateTime date-time

The datetime the task was completed.

Reference Count
referenceCount integer

The number of external references that exist on the task.

Id
id string

The id of the task.

assignments
_assignments array of object
Assigned To User Id
_assignments.userId string

The id of the user to whom this task was assigned to.

Assigned By User Id
_assignments.value.assignedBy.user.id string

The id of the user who assigned this task.

Assigned Date Time
_assignments.value.assignedDateTime date-time

The datetime the task was assigned.

Order Hint
_assignments.value.orderHint string

Order Hint

ListBuckets_Response

Name Path Type Description
value
value array of object
Name
value.name string

The name of the bucket.

Plan Id
value.planId string

The id of the plan this bucket belongs to.

Id
value.id string

The id of the bucket.

ListTasks_Response

Name Path Type Description
value
value array of object
Created by Display Name
value.createdBy.user.displayName string

The display name of the user who created this task.

Id
value.createdBy.user.id string

The id of the user who created this task.

Completed By Display Name
value.completedBy.user.displayName string

displayName

id
value.completedBy.user.id string

id

Plan Id
value.planId string

The id of the plan this task belongs to.

Bucket Id
value.bucketId string

The id of the bucket this task belongs to.

Title
value.title string

The title of the task.

Percent Complete
value.percentComplete integer

The completion percentage of the task.

Start Date Time
value.startDateTime date-time

The start datetime of the task.

Created Date Time
value.createdDateTime date-time

The datetime the task was created.

Due Date Time
value.dueDateTime date-time

The datetime the task is due.

Has Description
value.hasDescription boolean

Set to True if the task has a description.

Completed Date Time
value.completedDateTime date-time

The date time that the task was completed.

Reference Count
value.referenceCount integer

The number of external references that exist on the task.

Id
value.id string

The id of the task.

ListTasks_Response_V2

Name Path Type Description
value
value array of object
Created by Display Name
value.createdBy.user.displayName string

The display name of the user who created this task.

Id
value.createdBy.user.id string

The id of the user who created this task.

Completed By Display Name
value.completedBy.user.displayName string

displayName

id
value.completedBy.user.id string

id

Plan Id
value.planId string

The id of the plan this task belongs to.

Bucket Id
value.bucketId string

The id of the bucket this task belongs to.

Title
value.title string

The title of the task.

Percent Complete
value.percentComplete integer

The completion percentage of the task.

Start Date Time
value.startDateTime date-time

The start datetime of the task.

Created Date Time
value.createdDateTime date-time

The datetime the task was created.

Due Date Time
value.dueDateTime date-time

The datetime the task is due.

Has Description
value.hasDescription boolean

Set to True if the task has a description.

Completed Date Time
value.completedDateTime date-time

The date time that the task was completed.

Reference Count
value.referenceCount integer

The number of external references that exist on the task.

Id
value.id string

The id of the task.

assignments
value._assignments array of object
Assigned To User Id
value._assignments.userId string

The id of the user to whom this task was assigned to.

Assigned By User Id
value._assignments.value.assignedBy.user.id string

The id of the user who assigned this task.

Assigned Date Time
value._assignments.value.assignedDateTime date-time

The datetime the task was assigned.

Order Hint
value._assignments.value.orderHint string

Order Hint

ListMyPlans_Response

Name Path Type Description
value
value array of object
Title
value.title string

The title of the Plan.

Id
value.id string

The id of the plan.

GetTaskDetails_Response

Name Path Type Description
Description
description string

The description of the task.

Id
id string

The id of the task.

CreateBucket_Response

Name Path Type Description
Name
name string

Name of the bucket

Plan Id
planId string

Plan ID to which the bucket belongs

Order hint
orderHint string

Hint used to order items of this type in a list view

Id
id string

ID of the bucket