Todoist

Status: Production

Tier: Standard

Version: 1.1

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

ListProjectsV2 ()

List projects (V2)

ListItemsV2 ()

List tasks (V2)

ListItemsByProjectV2 (string id)

List tasks by project (V2)

ListLabelsV2 ()

List labels (V2)

CreateItemV2 (string project_id, CreateItemV2ParameterNewItem newItem)

Create a task (V2)

UpdateItemV2 (string id, string item_id, UpdateItemV2ParameterChangeItem changeItem)

Update a task (V2)

CreateProjectV2 (CreateProjectV2ParameterNewProject newProject)

Create a project (V2)

UpdateProjectV2 (string project_id, UpdateProjectV2ParameterChangeProject changeProject)

Update a project (V2)

ShareProjectV2 (string project_id, ShareProjectV2ParameterShareProject shareProject)

Share a project (V2)

CreateLabelV2 (CreateLabelV2ParameterNewLabel newLabel)

Create a label (V2)

UpdateLabelV2 (string label_id, UpdateLabelV2ParameterChangeLabel changeLabel)

Update a label (V2)

ListProjectsV3 ()

List projects (V3)

ListItemsV3 ()

List tasks (V3)

ListItemsByProjectV3 (integer project_id)

List tasks by project (V3)

ListLabelsV3 ()

List labels (V3)

CreateItemV3 (CreateItemV3ParameterNewItem newItem)

Create a task (V3)

UpdateItemV3 (integer project_id, string id, UpdateItemV3ParameterChangeItem changeItem)

Update a task (V3)

CreateProjectV3 (CreateProjectV3ParameterNewProject newProject)

Create a project (V3)

UpdateProjectV3 (integer id, UpdateProjectV3ParameterChangeProject changeProject)

Update a project (V3)

CreateLabelV3 (CreateLabelV3ParameterNewLabel newLabel)

Create a label (V3)

UpdateLabelV3 (string id, UpdateLabelV3ParameterChangeLabel changeLabel)

Update a label (V3)

Name

Summary

OnItemCompleted (string project_id)

When a task is completed

OnItemCreated (string project_id)

When a task is created

OnItemCompletedV2 (string project_id)

When a task is completed (V2)

OnItemCreatedV2 (string project_id)

When a task is created (V2)

Name

Summary

CompletedItem

CreateItemParameterNewItem

CreateItemV2ParameterNewItem

CreateItemV3ParameterNewItem

CreateLabelParameterNewLabel

CreateLabelV2ParameterNewLabel

CreateLabelV3ParameterNewLabel

CreateProjectParameterNewProject

CreateProjectV2ParameterNewProject

CreateProjectV3ParameterNewProject

Item

ItemV2

Label

LabelV2

LabelV3

ListItemsByProjectResponse

ListItemsByProjectV2Response

ListItemsResponse

ListItemsV2Response

ListLabelsResponse

ListLabelsV2Response

ListProjectsResponse

ListProjectsV2Response

OnItemCompletedResponse

OnItemCompletedV2Response

OnItemCreatedResponse

OnItemCreatedV2Response

Project

ProjectV3

ShareProjectParameterShareProject

ShareProjectV2ParameterShareProject

Task

UpdateItemParameterChangeItem

UpdateItemV2ParameterChangeItem

UpdateItemV3ParameterChangeItem

UpdateLabelParameterChangeLabel

UpdateLabelV2ParameterChangeLabel

UpdateLabelV3ParameterChangeLabel

UpdateProjectParameterChangeProject

UpdateProjectV2ParameterChangeProject

UpdateProjectV3ParameterChangeProject

Name

Type

Summary

Required

Related Action

id

string

(Project Id)

The unique identifier of the project.

True

ListProjects

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

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

Name

Type

Summary

Required

Related Action

newProject

CreateProjectParameterNewProject

A Todoist argument object for creating a Project

True

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

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

Name

Type

Summary

Required

Related Action

newLabel

CreateLabelParameterNewLabel

A Todoist argument object for creating a Label

True

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

Name

Type

Summary

Required

Related Action

id

string

(Project Id)

The unique identifier of the project.

True

ListProjectsV2

Name

Type

Summary

Required

Related Action

project_id

string

(Project Id)

The unique identifier of the project.

True

ListProjectsV2

newItem

CreateItemV2ParameterNewItem

A Todoist argument object for creating an Item

True

Name

Type

Summary

Required

Related Action

id

string

(Project Id)

The unique identifier of the project.

True

ListProjectsV2

item_id

string

(Task Id)

The unique identifier of the task.

True

ListItemsByProjectV2

changeItem

UpdateItemV2ParameterChangeItem

A Todoist argument object for updating an item

True

Name

Type

Summary

Required

Related Action

newProject

CreateProjectV2ParameterNewProject

A Todoist argument object for creating a Project

True

Name

Type

Summary

Required

Related Action

project_id

string

(Project Id)

The unique identifier of the project.

True

ListProjectsV2

changeProject

UpdateProjectV2ParameterChangeProject

A Todoist argument object for updating a Project

True

Name

Type

Summary

Required

Related Action

project_id

string

(Project Id)

The unique identifier of the project.

True

ListProjectsV2

shareProject

ShareProjectV2ParameterShareProject

A Todoist argument object for sharing a Project

True

Name

Type

Summary

Required

Related Action

newLabel

CreateLabelV2ParameterNewLabel

A Todoist argument object for creating a Label

True

Name

Type

Summary

Required

Related Action

label_id

string

(Label Id)

The unique identifier of the label.

True

ListLabelsV2

changeLabel

UpdateLabelV2ParameterChangeLabel

A Todoist argument object for updating a Label

True

Name

Type

Summary

Required

Related Action

project_id

integer

(Project Id)

The unique identifier of the project.

True

ListProjectsV3

Name

Type

Summary

Required

Related Action

newItem

CreateItemV3ParameterNewItem

A Todoist argument object for creating an Item

True

Name

Type

Summary

Required

Related Action

project_id

integer

(Project Id)

The unique identifier of the project.

True

ListProjectsV3

id

string

(Task Id)

The unique identifier of the task.

True

ListItemsByProjectV3

changeItem

UpdateItemV3ParameterChangeItem

A Todoist argument object for updating an item

True

Name

Type

Summary

Required

Related Action

newProject

CreateProjectV3ParameterNewProject

A Todoist argument object for creating a Project

True

Name

Type

Summary

Required

Related Action

id

integer

(Project Id)

The unique identifier of the project.

True

ListProjectsV3

changeProject

UpdateProjectV3ParameterChangeProject

A Todoist argument object for updating a Project

True

Name

Type

Summary

Required

Related Action

newLabel

CreateLabelV3ParameterNewLabel

A Todoist argument object for creating a Label

True

Name

Type

Summary

Required

Related Action

id

string

(Label Id)

The unique identifier of the label.

True

ListLabelsV3

changeLabel

UpdateLabelV3ParameterChangeLabel

A Todoist argument object for updating a Label

True

Name

Type

Summary

Required

Related Action

project_id

string

(Project Id)

The unique identifier of the project.

True

ListProjects

Name

Type

Summary

Required

Related Action

project_id

string

(Project Id)

The unique identifier of the project.

True

ListProjects

Name

Type

Summary

Required

Related Action

project_id

string

(Project Id)

The unique identifier of the project.

True

ListProjectsV2

Name

Type

Summary

Required

Related Action

project_id

string

(Project Id)

The unique identifier of the project.

True

ListProjectsV2

Name

Type

Summary

id

string

Task Entry Id

The id of the completed task entry.

task_id

integer(int32)

Task Id

The id of the completed task.

user_id

integer(int32)

Task Owner

The owner of the task.

project_id

string

Project Id

The project where task resides.

content

string

Task Title

The title of the task.

completed_date

string(date-time)

Date Completed

The date when the task was completed.

note_count

integer(int32)

Notes Count

The number of notes of the task.

meta_data

string

Details

Optional extra details.

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.

Name

Type

Summary

content

string

Title

The title of the task.

date_string

string(date-time)

Due Date

The task due date (e.g 2017-07-21T17:32:28Z).

priority

string

Priority

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

parent_id

string

Parent Id

The id of the parent task. Set to null for root tasks

child_order

integer

Child order

The order of task. Defines the position of the task among all the tasks with the same Parent Id

Name

Type

Summary

content

string

Title

The title of the task.

project_id

integer

Project Id

Task project id. If not set, task is put to user’s Inbox.

due_string

string(date-time)

Due Date

The task due date (e.g 2017-07-21T17:32:28Z).

priority

string

Priority

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

parent_id

integer

Parent Id

The id of the parent task. Set to null for root tasks

order

integer

Child order

The order of task. Defines the position of the task among all the tasks with the same Parent Id

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).

Name

Type

Summary

name

string

Name

The name of the label.

color

string

Color

Color id. It’s a value between 30 and 49.

item_order

string

Order

Label’s order in the label list (a number, where the smallest value should place the label at the top).

Name

Type

Summary

name

string

Name

The name of the label.

color

integer

Color

Color id. It’s a value between 30 and 49.

order

integer

Order

Label’s order in the label list (a number, where the smallest value should place the label at the top).

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.

Name

Type

Summary

name

string

Name

The name of the project.

color

integer

Color

Color id. It’s a value between 30 and 49.

parent_id

string

Parent Id

The id of the parent project. Set to null for root projects

child_order

integer

Child order

The order of project. Defines the position of the project among all the projects with the same Parent Id

is_favorite

integer

Is favorite

Whether the project is favorite (where 1 is true and 0 is false).

Name

Type

Summary

name

string

Name

The name of the project.

color

integer

Color

Color id. It’s a value between 30 and 49.

parent_id

integer

Parent Id

The id of the parent project. Set to null for root projects

favorite

boolean

Is favorite

Whether the project is favorite (a true or false value).

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.

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 2006-08-07T16:34:56Z.

parent_id

integer(int32)

Parent Id

The id of the parent task. Set to null for root tasks

child_order

integer(int32)

Child order

The order of task. Defines the position of the task among all the tasks with the same parent_id

priority

integer(int32)

Task Priority

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

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).

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).

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.

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).

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

Color id. It’s a value between 30 and 49, more info - https://developer.todoist.com/sync/v8/#colors

item_order

integer(int32)

Order

Label’s order in the label list (a number, where the smallest value should place the label at the top).

is_deleted

integer(int32)

IsDeleted

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

is_favorite

integer(int32)

IsFavorite

Whether the label is favorite (where 1 is true and 0 is false).

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

Color id. It’s a value between 30 and 49, more info - https://developer.todoist.com/sync/v8/#colors

order

integer(int32)

Order

Label’s order in the label list (a number, where the smallest value should place the label at the top).

favorite

boolean

IsFavorite

Whether the label is favorite (a true or false value).

Name

Type

Summary

items

array of (Item)

Items

A collection of items

Name

Type

Summary

items

array of (ItemV2)

Items

A collection of items

Name

Type

Summary

items

array of (Item)

Items

A collection of items

Name

Type

Summary

items

array of (ItemV2)

Items

A collection of items

Name

Type

Summary

labels

array of (Label)

Labels

A collection of labels

Name

Type

Summary

labels

array of (LabelV2)

Labels

A collection of labels

Name

Type

Summary

projects

array of (Project)

Projects

A collection of projects

Name

Type

Summary

projects

array of (Project)

Projects

A collection of projects

Name

Type

Summary

items

array of (Item)

Items

A collection of items

Name

Type

Summary

items

array of (CompletedItem)

Completed Items

A collection of completed items

Name

Type

Summary

items

array of (Item)

Items

A collection of items

Name

Type

Summary

items

array of (ItemV2)

Items

A collection of items

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 archived.

Name

Type

Summary

id

integer(int32)

Project Id

The unique identifier of the project.

name

string

Project Name

The name of the project.

comment_count

integer(int32)

Comment Count

The number of comments.

order

integer(int32)

Order

The order of the project under the same parent.

color

integer(int32)

Color

The color of the project.

shared

boolean

Is Project Shared

Is Project Shared

sync_id

integer(int32)

Sync Id

Identifier to find the match between different copies of shared projects.

favorite

boolean

Is Project Favorite

Is Project Favorite

inbox_project

boolean

Is Project Shared

Is Project Inbox

Name

Type

Summary

email

string

Email

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

Name

Type

Summary

email

string

Email

The user email with whom to share the project.

Name

Type

Summary

id

integer(int32)

Task Id

The id of the task.

completed

boolean

Is Task Completed

Is task completed

project_id

integer(int32)

Project Id

The project where task resides.

section_id

integer(int32)

Section Id

Id of section task belongs to.

parent_id

integer(int32)

Parent Id

The id of the parent task. Set to null for root tasks.

content

string

Task content

Task content.

comment_count

integer(int32)

Comment count

Number of task comments

order

integer(int32)

Order

The order of task. Defines the position of the task among all the tasks with the same parent_id

priority

integer(int32)

Task Priority

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

url

string

Task URL

URL to access this task in Todoist web interface.

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.

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.

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.

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).

Name

Type

Summary

name

string

Name

The name of the label.

color

string

Color

Color id. It’s a value between 30 and 49.

item_order

string

Order

Label’s order in the label list.

Name

Type

Summary

name

string

Name

The name of the label.

color

integer

Color

Color id. It’s a value between 30 and 49.

order

integer

Order

Label’s order in the label list.

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.

Name

Type

Summary

name

string

Name

The name of the project.

color

string

Color

Color id. It’s a value between 30 and 49.

is_favorite

integer

Is favorite

Whether the project is favorite (where 1 is true and 0 is false).

Name

Type

Summary

name

string

Name

The name of the project.

color

string

Color

Color id. It’s a value between 30 and 49.

favorite

boolean

Is favorite

Whether the project is favorite (a true or false value).