Connectors Reference

Todoist

Todoist is an online task management app and todo list. With Todoist, users can organize, schedule, maintain and prioritize personal tasks.

 

Status: Production

Tier: Standard

Version: 1.1

 

Actions:

Name

Summary

ListProjects ()

List projects

ListItems ()

List tasks

ListItemsByProject (string id)

List tasks by project

ListLabels ()

List labels

CreateItem (string project_id, CreateItemParameterNewItem newItem)

Create a task

UpdateItem (string id, string item_id, UpdateItemParameterChangeItem changeItem)

Update a task

CreateProject (CreateProjectParameterNewProject newProject)

Create a project

UpdateProject (string project_id, UpdateProjectParameterChangeProject changeProject)

Update a project

ShareProject (string project_id, ShareProjectParameterShareProject shareProject)

Share a project

CreateLabel (CreateLabelParameterNewLabel newLabel)

Create a label

UpdateLabel (string label_id, UpdateLabelParameterChangeLabel changeLabel)

Update a label

 

Triggers:

Name

Summary

OnItemCompleted (string project_id)

When a task is completed

OnItemCreated (string project_id)

When a task is created

 

Objects:

Name

Summary

CreateItemParameterNewItem

 

CreateLabelParameterNewLabel

 

CreateProjectParameterNewProject

 

Item

 

Label

 

ListItemsByProjectResponse

 

ListItemsResponse

 

ListLabelsResponse

 

ListProjectsResponse

 

OnItemCompletedResponse

 

OnItemCreatedResponse

 

Project

 

ShareProjectParameterShareProject

 

UpdateItemParameterChangeItem

 

UpdateLabelParameterChangeLabel

 

UpdateProjectParameterChangeProject

 

 

Actions:

ListProjects

Summary: List projects

Description: List all projects in the Todoist account.

 

Syntax:

Todoist.ListProjects ()

 

Returns:

          Type:ListProjectsResponse

          Description: A Todoist Projects response object

 

ListItems

Summary: List tasks

Description: List all tasks in the Todoist account.

 

Syntax:

Todoist.ListItems ()

 

Returns:

          Type:ListItemsResponse

          Description: A Todoist Items response object

 

ListItemsByProject

Summary: List tasks by project

Description: List all tasks in a specific project.

 

Syntax:

Todoist.ListItemsByProject (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Project Id)

The unique identifier of the project.

True

ListProjects

 

Returns:

          Type:ListItemsByProjectResponse

          Description: A Todoist Items response object

 

ListLabels

Summary: List labels

Description: List the labels configured in the Todoist account.

 

Syntax:

Todoist.ListLabels ()

 

Returns:

          Type:ListLabelsResponse

          Description: A Todoist Labels response object

 

CreateItem

Summary: Create a task

Description: Create a new task in the specified project.

 

Syntax:

Todoist.CreateItem (string project_id, CreateItemParameterNewItem newItem)

 

Parameters:

Name

Type

Summary

Required

Related Action

project_id

string

(Project Id)

The unique identifier of the project.

True

ListProjects

newItem

CreateItemParameterNewItem

 

A Todoist argument object for creating an Item

True

 

Returns:

          Type:Item

          Description: A Todoist Item Object

 

UpdateItem

Summary: Update a task

Description: Update an existing task.

 

Syntax:

Todoist.UpdateItem (string id, string item_id, UpdateItemParameterChangeItem changeItem)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Project Id)

The unique identifier of the project.

True

ListProjects

item_id

string

(Task Id)

The unique identifier of the task.

True

ListItemsByProject

changeItem

UpdateItemParameterChangeItem

 

A Todoist argument object for updating an item

True

 

Returns:

          Type:Item

          Description: A Todoist Item Object

 

CreateProject

Summary: Create a project

Description: Create a new project.

 

Syntax:

Todoist.CreateProject (CreateProjectParameterNewProject newProject)

 

Parameters:

Name

Type

Summary

Required

Related Action

newProject

CreateProjectParameterNewProject

 

A Todoist argument object for creating a Project

True

 

Returns:

          Type:Project

          Description: A Todoist Project Object

 

UpdateProject

Summary: Update a project

Description: Update an existing project.

 

Syntax:

Todoist.UpdateProject (string project_id, UpdateProjectParameterChangeProject changeProject)

 

Parameters:

Name

Type

Summary

Required

Related Action

project_id

string

(Project Id)

The unique identifier of the project.

True

ListProjects

changeProject

UpdateProjectParameterChangeProject

 

A Todoist argument object for updating a Project

True

 

Returns:

          Type:Project

          Description: A Todoist Project Object

 

ShareProject

Summary: Share a project

Description: Share an existing project to a specific user.

 

Syntax:

Todoist.ShareProject (string project_id, ShareProjectParameterShareProject shareProject)

 

Parameters:

Name

Type

Summary

Required

Related Action

project_id

string

(Project Id)

The unique identifier of the project.

True

ListProjects

shareProject

ShareProjectParameterShareProject

 

A Todoist argument object for sharing a Project

True

 

Returns:

          Type:Project

          Description: A Todoist Project Object

 

CreateLabel

Summary: Create a label

Description: Create a new label (premium users only).

 

Syntax:

Todoist.CreateLabel (CreateLabelParameterNewLabel newLabel)

 

Parameters:

Name

Type

Summary

Required

Related Action

newLabel

CreateLabelParameterNewLabel

 

A Todoist argument object for creating a Label

True

 

Returns:

          Type:Label

          Description: A Todoist Label Object

 

UpdateLabel

Summary: Update a label

Description: Update an existing label.

 

Syntax:

Todoist.UpdateLabel (string label_id, UpdateLabelParameterChangeLabel changeLabel)

 

Parameters:

Name

Type

Summary

Required

Related Action

label_id

string

(Label Id)

The unique identifier of the label.

True

ListLabels

changeLabel

UpdateLabelParameterChangeLabel

 

A Todoist argument object for updating a Label

True

 

Returns:

          Type:Label

          Description: A Todoist Label Object

 

Triggers:

Trigger OnItemCompleted

Summary: When a task is completed

Description: Triggers a new flow when a task is completed.

 

Syntax:

Todoist.OnItemCompleted (string project_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

project_id

string

(Project Id)

The unique identifier of the project.

True

ListProjects

 

Returns:

          Type:OnItemCompletedResponse

          Description: A Todoist Items response object

 

Trigger OnItemCreated

Summary: When a task is created

Description: Trigers a new flow when a task is created.

 

Syntax:

Todoist.OnItemCreated (string project_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

project_id

string

(Project Id)

The unique identifier of the project.

True

ListProjects

 

Returns:

          Type:OnItemCreatedResponse

          Description: A Todoist Items response object

 


 

CreateItemParameterNewItem

Summary:

Description: A Todoist argument object for creating an Item

 

          Properties:

Name

Type

Summary

content

string

Title

The title of the task.

date_string

string(date-time)

Due Date

The task due date (e.g mm-dd-yyyy, Today @ 11am, mm/dd/yyyy).

priority

string

Priority

A number between 1 and 4 (4 for very urgent and 1 for natural).

indent

string

Indent

A number between 1 and 4, where 1 is top-level).

item_order

string

Order

A number, where the smallest value is top-level.


 

CreateLabelParameterNewLabel

Summary:

Description: A Todoist argument object for creating a Label

 

          Properties:

Name

Type

Summary

name

string

Name

The name of the label.

color

string

Color

The color of the label (a number between 0 and 7, or 0 and 12 for premium users).

item_order

string

Order

The label's order in the label list (a number, where the smallest value is top-level).


 

CreateProjectParameterNewProject

Summary:

Description: A Todoist argument object for creating a Project

 

          Properties:

Name

Type

Summary

name

string

Name

The name of the project.

color

string

Color

A number between 0 and 11, or 0 and 21 for premium users.

indent

string

Indent

A number between 1 and 4, where 1 is top-level).

item_order

string

Order

A number, where the smallest value is top-level.


 

Item

Summary:

Description: A Todoist Item Object

 

          Properties:

Name

Type

Summary

content

string

Task Title

The title of the task.

id

string

Task Id

The id of the task.

user_id

integer(int32)

Task Owner

The owner of the task.

project_id

string

Project Id

The project where task resides.

date_lang

string

Date Language

The language of the date (valid languages are: en, da, pl, zh, ko, de, pt, ja, it, fr, sv, ru, es, nl).

due_date_utc

string(date-time)

Task Due Date

The date of the task in the format Mon 07 Aug 2006 12:34:56 +0000.

indent

integer(int32)

Indent

The indent of the task (a number between 1 and 4, where 1 is top-level).

priority

integer(int32)

Task Priority

The priority of the task (a number between 1 and 4, 4 for very urgent and 1 for natural).

item_order

integer(int32)

Order

The order of the task inside a project (the smallest value would place the task at the top).

day_order

integer(int32)

DayOrder

The order of the task inside the Today or Next 7 days view (a number, where the smallest value would place the task at the top).

collapsed

integer(int32)

Collapsed

Whether the task’s sub-tasks are collapsed (where 1 is true and 0 is false).

children

string

Children

Children

assigned_by_uid

integer(int32)

Assigner Id

The id of the user who assigns the current task. For shared projects only.

responsible_uid

integer(int32)

Assignee Id

The id of user who is responsible for accomplishing the current task. For shared projects only.

checked

integer(int32)

IsTaskCompleted

Whether the task is marked as completed (where 1 is true and 0 is false).

in_history

integer(int32)

IsTaskInHistory

Whether the task has been marked as completed and is marked to be moved to history.

is_deleted

integer(int32)

IsDeleted

Whether the task is marked as deleted (where 1 is true and 0 is false).

is_archived

integer(int32)

IsTaskArchived

Whether the task is marked as archived (where 1 is true and 0 is false).

sync_id

integer(int32)

SyncId

A special id for shared tasks (a number or null if not set). Used internally and can be ignored.

date_added

string(date-time)

Date Created

The date when the task was created.


 

Label

Summary:

Description: A Todoist Label Object

 

          Properties:

Name

Type

Summary

id

integer(int32)

Label Id

The id of the label.

name

string

Label Name

The name of the label.

color

integer(int32)

Color

The color of the label (a number between 0 and 7, or between 0 and 12 for premium users).

item_order

integer(int32)

Order

Label’s order in the label list (a number, where the smallest value is top-level).

is_deleted

integer(int32)

IsDeleted

Whether the label is marked as deleted (where 1 is true and 0 is false).


 

ListItemsByProjectResponse

Summary:

Description: A Todoist Items response object

 

          Properties:

Name

Type

Summary

items

array of (Item)

Items

A collection of items


 

ListItemsResponse

Summary:

Description: A Todoist Items response object

 

          Properties:

Name

Type

Summary

items

array of (Item)

Items

A collection of items


 

ListLabelsResponse

Summary:

Description: A Todoist Labels response object

 

          Properties:

Name

Type

Summary

labels

array of (Label)

Labels

A collection of labels


 

ListProjectsResponse

Summary:

Description: A Todoist Projects response object

 

          Properties:

Name

Type

Summary

projects

array of (Project)

Projects

A collection of projects


 

OnItemCompletedResponse

Summary:

Description: A Todoist Items response object

 

          Properties:

Name

Type

Summary

items

array of (Item)

Items

A collection of items


 

OnItemCreatedResponse

Summary:

Description: A Todoist Items response object

 

          Properties:

Name

Type

Summary

items

array of (Item)

Items

A collection of items


 

Project

Summary:

Description: A Todoist Project Object

 

          Properties:

Name

Type

Summary

id

string

Project Id

The unique identifier of the project.

name

string

Project Name

The name of the project.

color

integer(int32)

Color

The color of the project.

shared

boolean

Is Project Shared

Is Project Shared

is_deleted

integer(int32)

Is Project Deleted

A number value (1 is true, 0 is false) indicating whether or not the project is deleted.

is_archived

integer(int32)

Is Project Archived

A number value (1 is true, 0 is false) indicating whether or not the project is deleted.


 

ShareProjectParameterShareProject

Summary:

Description: A Todoist argument object for sharing a Project

 

          Properties:

Name

Type

Summary

email

string

Email

The email address of user the project is being shared to.


 

UpdateItemParameterChangeItem

Summary:

Description: A Todoist argument object for updating an item

 

          Properties:

Name

Type

Summary

content

string

Title

The title of the task.

priority

string

Priority

A number between 1 and 4, 4 for very urgent and 1 for natural.

indent

string

Indent

A number between 1 and 4, where 1 is top-level).

item_order

string

Order

A number, where the smallest value is top-level.


 

UpdateLabelParameterChangeLabel

Summary:

Description: A Todoist argument object for updating a Label

 

          Properties:

Name

Type

Summary

name

string

Name

The name of the label.

color

string

Color

The color of the label (a number between 0 and 7, or 0 and 12 for premium users).

item_order

string

Order

The label's order in the label list (a number, where the smallest value is top-level).


 

UpdateProjectParameterChangeProject

Summary:

Description: A Todoist argument object for updating a Project

 

          Properties:

Name

Type

Summary

name

string

Name

The name of the project.

color

string

Color

A number between 0 and 11, or 0 and 21 for premium users.

indent

string

Indent

A number between 1 and 4, where 1 is top-level).

item_order

string

Order

A number, where the smallest value is top-level.