Shortcuts for Planner
Last Updated:
Shortcuts for the Planner let you create and manage events, tasks, and notes without opening the app.
Create Event
Creates a new event in the Planner.
| Parameter | Description |
|---|---|
| Title | The name of the event |
| Start Date | When the event starts |
| End Date | When the event ends |
| All Day | Whether this is an all-day event. Off by default |
| Description | Optional. An event description |
Create Task
Creates a new task in the Planner.
| Parameter | Description |
|---|---|
| Title | The name of the task |
| Due Date | Optional. When the task is due |
| Priority | None, Low, Medium, or High. Defaults to None |
| Note | Optional. A note for the task |
Create Note
Creates a new note in the Planner.
| Parameter | Description |
|---|---|
| Title | The title of the note |
| Note Text | The text of the note |
| Start Date | Optional. When to schedule the note |
Complete Task
Toggles a task’s completion. An incomplete task is marked complete, and a completed task is marked incomplete.
| Parameter | Description |
|---|---|
| Task | The task to complete |
Get Events
Returns events from the Planner. Every parameter is optional.
| Parameter | Description |
|---|---|
| Search Text | Only return events whose title matches |
| Start After | Only return events starting after this date |
| Start Before | Only return events starting before this date |
| Pinned Only | Only return pinned events. Off by default |
| Sort By | Date Added, Start Date, or Title. Defaults to Start Date |
| Sort Order | Ascending or Descending. Defaults to Ascending |
| Limit | The most events to return. Defaults to 50 |
| Offset | How many events to skip, for paging. Defaults to 0 |
Get Tasks
Returns tasks from the Planner. Every parameter is optional.
| Parameter | Description |
|---|---|
| Search Text | Only return tasks whose title matches |
| Completed | Filter by completion status |
| Due Before | Only return tasks due before this date |
| Due After | Only return tasks due after this date |
| Pinned Only | Only return pinned tasks. Off by default |
| Sort By | Date Added, Due Date, Title, or Priority. Defaults to Date Added |
| Sort Order | Ascending or Descending. Defaults to Descending |
| Limit | The most tasks to return. Defaults to 50 |
| Offset | How many tasks to skip, for paging. Defaults to 0 |
Get Notes
Returns notes from the Planner. Every parameter is optional.
| Parameter | Description |
|---|---|
| Search Text | Only return notes whose title matches |
| Start After | Only return notes starting after this date |
| Start Before | Only return notes starting before this date |
| Pinned Only | Only return pinned notes. Off by default |
| Sort By | Date Added, Start Date, or Title. Defaults to Date Added |
| Sort Order | Ascending or Descending. Defaults to Descending |
| Limit | The most notes to return. Defaults to 50 |
| Offset | How many notes to skip, for paging. Defaults to 0 |
Update Event
Updates an existing event. Fields you leave empty stay as they are.
| Parameter | Description |
|---|---|
| Event | The event to update |
| New Title | Optional. A new title |
| New Start Date | Optional. A new start date |
| New End Date | Optional. A new end date |
| All Day | Optional. Whether this is an all-day event |
| New Description | Optional. A new description |
| Pinned | Optional. Pin or unpin the event |
Update Task
Updates an existing task. Fields you leave empty stay as they are.
| Parameter | Description |
|---|---|
| Task | The task to update |
| New Title | Optional. A new title |
| New Due Date | Optional. A new due date |
| New Priority | Optional. A new priority |
| New Note | Optional. A new note |
| Pinned | Optional. Pin or unpin the task |
Update Note
Updates an existing note. Fields you leave empty stay as they are.
| Parameter | Description |
|---|---|
| Note | The note to update |
| New Title | Optional. A new title |
| New Note Text | Optional. New text for the note |
| New Start Date | Optional. A new start date |
| Pinned | Optional. Pin or unpin the note |