Todoist Pipe
This article is still being written, please check back soon.
People and teams that organize, plan, and collaborate on tasks and projects with Todoist. Todoist gives you the confidence that everything’s organized and accounted for, so you can make progress on the things that are important to you.
Global Parameters
There are 2 Global Parameters in this pipe.
- Auth-Id
- Authorization
To obtain these details log into your Todoist account...
All API calls below must contain the authorization details in the global parameters.
API Calls
All the API Calls in this Pipe can be customized, but we've added several to help you get started and expedite the time needed to get you up and running with some of the basic uses.
Projects
- Create a Project
- View a Project
- Update a Project
- Delete a Project
Create a Project
Allow to create a new project in your todoist account.
URL
First you can pass a URL and Method in the overview tab for create a project. The required URL and method that must be included below :
- Method : POST
- Request URL : https://tadapipes.tadabase.io/proxy/todoist/projects
Parameters
Add required parameters values for dynamically assigned in the API Call request. Set required Parameters must be included in parameters tab.
- Name - Project name
- Color id - Color id. It’s a value between 30 and 49, refer to Color id for more info.
- Favorite - Whether the project is a favorite (a
true
orfalse
value).
Headers
Here requires unique header values for api endpoint, that value is set in a global parameters. Required header value must be included in headers tab. Here assign parameter that created at global parameter tab.
Request
Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for creating the project. Here {name}, {color} and {favorite} is assigned parameters that created in parameters tab.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data.
In above screenshot we don't have to enter a Auth-Id and Authorization because of already added both value set as default in default option in global parameter.
Response
Built in responses already added are below.
- ID
- Order
- Color
- Name
- Comment count
- Shared
- Favorite
- Sync id
Output in todoist
-
Open todoist.com account and go to project section visible at left & side menu bar."Online Store" is new created project that added into test tab.
View a Project
Allow to view a project by project id in your todoist account.
URL
First you can pass a URL and Method in the overview tab for view a project. The required URL and method that must be included below :
- Method: GET
- Request URL: https://tadapipes.tadabase.io/proxy/todoist/projects/{id}
Parameters
Set required Parameters must be included in parameters tab.
- id - Project id
Headers
There are 2 header Parameters in this pipe same as a "create a project" pipe header.
Test
Now You can test this API call directly within the API Call test tab. There are parameters for all these values and the request must not be blank. Using data from this test we can begin generating and response data.
In above screenshot we don't have to enter a Auth-Id and Authorization because of already added both value set as default in default option in global parameter.
Response
Built in responses already added are below.
- ID
- Order
- Color
- Name
- Comment count
- Shared
- Favorite
- Sync id
Update a Project
Allow to update a project using a project id in your todoist account.
URL
First you can pass a URL and Method in the overview tab for update a project. The required URL and method that must be included below :
- Method : POST
- Request URL : https://tadapipes.tadabase.io/proxy/todoist/projects/{id}
Parameters
Set Parameters must be included in parameters tab.
- Project id - ( Required )
- Name - Project name ( Required )
- Color id - Color id. It’s a value between 30 and 49, refer to Color id for more info ( Optional ).
- Favorite - Whether the project is a favorite (a
true
orfalse
value) ( Optional ).
Headers
There are 2 header Parameters required in this pipe same as a header of "create a project" pipe.
Request
Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for updating the project. here update {name}, {color} and {favorite} is assign parameter .
Test
You can test update a project API directly within the API Call test tab. There are parameters for all these values must not be blank.
In above screenshot we don't have to enter a Auth-Id and Authorization because of already added both value set as default in default option in global parameter. Response of update a project return null and response code is 204.
Response
Here responses is not added because of response of update a project return null.
Output in todoist
-
Open todoist.com account and go to project section visible at left & side menu bar. "Online Store" is old project name now new updated project name is "Online shopping" that added into test tab.
Delete a Project
Allow to delete a project by project id in your todoist account.
URL
First you can pass a URL and Method in the overview tab for delete a project. The required URL and method that must be included below :
- Method:DELETE
- Request URL: https://tadapipes.tadabase.io/proxy/todoist/projects/{id}
Parameters
Set required Parameters must be included in parameters tab.
- id - Project id (Required)
Headers
There are 2 header Parameters in this pipe same as a "create a project" pipe header.
Test
Now You can test this API call directly within the API Call test tab.Project id must not be blank for deletes a project and returns an empty response.
Response
Returns an empty response for deleting a project.
Sections
- Create a Section
- View a Section
- Update a Section
- Delete a Section
Create a Section
Allow to create a new section of project in your todoist account.
URL
First you can pass a URL and Method in the overview tab for create a section. The required URL and method that must be included below :
- Method : POST
- Request URL : https://tadapipes.tadabase.io/proxy/todoist/sections
Parameters
Set required parameters must be included in parameters tab.
- Project id - Project ID this section should belong to (Required)
- Section name - (Required)
Headers
There are 3 header Parameters must be included below.
Request
Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for creating section of project. Here {project_id} and {name} is assign parameter.
Test
Now You can test this API call directly within the API Call test tab. Project id with Section name must not be blank for create section of project and successful response has 200 OK
status.
Response
Built in responses already added are below.
- ID
- Project id
- Order
- Name
Here map these responses to a specific name you choose and can then use it within your app.
Output in todoist
-
Open todoist.com account and go to project visible at left & side menu bar. Visit your project where new section is "Banner Section" created.
View a Section
Allow to view a section by section id in your todoist account.
URL
First you can pass a URL and Method in the overview tab for view a section. The required URL and method that must be included below :
- Method: GET
- Request URL: https://tadapipes.tadabase.io/proxy/todoist/sections/{id}
Parameters
Set required Parameters must be included in parameters tab.
- Section id - (Required)
Headers
There are 3 header Parameters must be included below.
Test
Now You can test this API call directly within the API Call test tab. Section id must be required for getting details of section. Successful response has 200 OK
status.
Response
Built in responses already added are below.
- ID
- Project id
- Order
- Name
Here map these responses to a specific name you choose and can then use it within your app.
Delete a Section
Allow to delete a Section by section id.
URL
First you can pass a URL and Method in the overview tab for remove a section. The required URL and method that must be included below :
- Method: DELETE
- Request URL: https://tadapipes.tadabase.io/proxy/todoist/sections/{id}
Parameters
Set required Parameters must be included in parameters tab.
- Section id - (Required)
Headers
There are 2 header Parameters must be required.
Test
Now You can test this API call directly within the API Call test tab. Section id must not be blank for remove a section and returns an empty response. Successful response has 204 No Content
status.
Response
Here data mapping is not possible because of returns an empty response.
Update a Section
Allow to update a section by section id of project.
URL
First you can pass a URL and Method in the overview tab for update a section. The required URL and method that must be included below :
- Method : POST
- Request URL : https://tadapipes.tadabase.io/proxy/todoist/sections/{id}
Parameters
Set required parameters must be included in parameters tab.
- Project id - Project ID this section should belong to (Required)
- Section name - (Required)
Headers
There are 3 header Parameters must be included below.
Request
Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for updating section. Here {name} is assign parameter.
Test
Now You can test this API call directly within the API Call test tab. Section id and Name must not be blank for Update a section and returns an empty response. Successful response has 204 No Content
status..
Response
Here data mapping is not possible because of successful response has an empty body and 204 No Content
status.
Output in todoist
-
Open todoist.com account and visit your project where section is updated. Here "Poster Section" is updated ( see below screenshot ).
Task
- Create a Task
- View a Task
- Update a Task
- Delete a Task
- Close a Task
- Reopen Task
Create a Task
Allow to create a new Task of section.
URL
First you can pass a URL and Method in the overview tab for create a task. The required URL and method that must be included below :
- Method : POST
- Request URL : https://tadapipes.tadabase.io/proxy/todoist/task
Parameters
Set required parameters must be included in parameters tab.
- Content - Name of task (Required).
- Due date - Specific date in
YYYY-MM-DD
format (Optional). - Priority - Task priority from 1-normal to 4-urgent (Optional).
- Project id - Task project id. If not set, task is put to user inbox (Optional).
- Section id - Id of section to put task into (Optional).
Headers
There are 3 header Parameters must be included below.
Request
Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for creating task in section. Here {content}, {due_date}, {priority}, {project_id} and {section_id} is assign parameter.
Test
Now You can test this API call directly within the API Call test tab. Content field must not be blank for create a new task and Successful response has 200
status.
Response
Built in responses already added are below. Here map these responses to a specific name you choose and can then use it within your app.
- ID
- Project id
- Section id
- Order
- Content
- Priority
- Creator
- String
- Date
Output in todoist
-
Open todoist.com account and visit your Projects where Task is added. Here "Add a link to poster" is new task in section of project ( see below screenshot ).
View a Task
Allow to returns an active (non-completed) task by id.
URL
First you can pass a URL and Method in the overview tab for details of task. The required URL and method that must be included below :
- Method: GET
- Request URL: https://tadapipes.tadabase.io/proxy/todoist/task/{id}
Parameters
Set required Parameters must be included in parameters tab.
- Task id - (Required)
Headers
There are 1 header Parameters must be included below.
Test
Now You can test this API call directly within the API Call test tab. Task id must be required for getting details of task. Successful response has 200 OK
status.
In above screenshot no need to add Auth id only required a Authorization and Task id.
Response
Built in responses already added are below. Here map these responses to a specific name you choose and can then use it within your app.
- ID
- Project id
- Section id
- Order
- Content
- Priority
- Creator
- String
- Date
Update a Task
Allow to update a Task by id.
URL
First you can pass a URL and Method in the overview tab for update a task. The required URL and method that must be included below :
- Method : POST
- Request URL : https://tadapipes.tadabase.io/proxy/todoist/tasks/{id}
Parameters
Set required parameters must be included in parameters tab.
- Task id - (Required)
- Content - name of task (Required)
- Completed - allow to 'ture' or 'false'.
Headers
There are 3 header Parameters must be included below.
Request
Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for updating task. Here {content} and {completed} is assign parameter.
Test
Now You can test this API call directly within the API Call test tab. Task id and Content or Completed field must be required for update task. Successful response has 204 OK
status and return empty response.
Response
Here data mapping is not possible because of successful response has an empty body and 204 No Content
status.
Output in todoist
- Open todoist.com account and visit your Projects where Task is updated. Here "Set a full width poster" is task updated in section of project ( see below screenshot ).
Delete a Task
Allow to delete a task by id.
URL
First you can pass a URL and Method in the overview tab for remove task. The required URL and method that must be included below :
- Method: DELETE
- Request URL: https://tadapipes.tadabase.io/proxy/todoist/task/{id}
Parameters
Set required Parameters must be included in parameters tab.
- Task id - (Required)
Headers
There are 2 header Parameters must be required.
Test
Now You can test this API call directly within the API Call test tab. Task id must not be blank for remove a task and returns an empty response. Successful response has 204 No Content
status.
Response
Here data mapping is not possible because of returns an empty response.
Close a Task
Allow to close a task by task id. The command does exactly what official clients do when you close a task. Regular tasks are completed and moved to history, subtasks are checked (marked as done, but not moved to history), recurring tasks are moved forward (due date is updated).
URL
First you can pass a URL and Method in the overview tab for close task. The required URL and method that must be included below :
- Method: POST
- Request URL: https://tadapipes.tadabase.io/proxy/todoist/tasks/{id}/close
Parameters
Set required Parameters must be included in parameters tab.
- Task id - (Required)
Headers
There are 2 header Parameters must be required.
Test
Now You can test this API call directly within the API Call test tab. Task id must not be blank for close a task and returns an empty response. Successful response has 204 No Content
status.
Response
Here data mapping is not possible because of returns an empty response.
Reopen a Task
Allow to reopen a task by task id. This command reopens a previously closed task. Works both with checked tasks in the user’s workspace and tasks moved to history. The behaviour varies for different types of tasks (the command follows the behaviour of official clients when tasks are uncompleted or extracted from the history).
URL
First you can pass a URL and Method in the overview tab for reopen task. The required URL and method that must be included below :
- Method: POST
- Request URL: https://tadapipes.tadabase.io/proxy/todoist/tasks/{id}/reopen
Parameters
Set required Parameters must be included in parameters tab.
- Task id - (Required)
Headers
There are 2 header Parameters must be required.
Test
Now You can test this API call directly within the API Call test tab. Task id must not be blank for reopens a previously closed task and returns an empty response. Successful response has 204 No Content
status.
Response
Here data mapping is not possible because of returns an empty response.
Comment
- Create a Comment
- View a Comment
- Update a Comment
- Delete a Comment
Create a Comment
Allow to create a comment in task.
URL
First you can pass a URL and Method in the overview tab for create a comment. The required URL and method that must be included below :
- Method: POST
- Request URL: https://tadapipes.tadabase.io/proxy/todoist/comments
Parameters
Set required Parameters must be included in parameters tab.
- Task id - (Required)
- Content - name of comment (Required)
Headers
There are 2 header Parameters must be required.
Request
Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for create a comment. Here {task_id} and {content} is assign parameter.
Test
Now You can test this API call directly within the API Call test tab. Task id must not be blank for create new comment. Successful response has 200 Ok
status.
Response
Built in responses already added are below.
- ID
- Content
- Task id
- Posted
View a Comment
Allow to returns an comment by id.
URL
First you can pass a URL and Method in the overview tab for details of comment. The required URL and method that must be included below :
- Method: GET
- Request URL: https://tadapipes.tadabase.io/proxy/todoist/comments/{id}
Parameters
Set required Parameters must be included in parameters tab.
- Comment id - (Required)
Headers
There are 2 header Parameters must be included below.
Test
Now You can test this API call directly within the API Call test tab. Comment id must be required for getting details of comment. Successful response has 200 OK
status.
Response
Built in responses already added are below.
- ID
- Content
- Task id
- Posted
Update a Comment
Allow to update a comment by id.
URL
First you can pass a URL and Method in the overview tab for update a comment. The required URL and method that must be included below :
- Method : POST
- Request URL : https://tadapipes.tadabase.io/proxy/todoist/comment/{id}
Parameters
Set required parameters must be included in parameters tab.
- Comment id - (Required)
- Content - name of comment(Required)
Headers
There are 2 header Parameters must be included below.
Request
Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for updating comment. Here {content} is assign parameter.
Test
Now You can test this API call directly within the API Call test tab. Comment id and Content must be required for update comment. Successful response has 204 No Content
status.
Response
Here data mapping is not possible because of successful response has an empty body and 204 No Content
status.
Delete a Comment
Allow to delete a comment by id.
URL
First you can pass a URL and Method in the overview tab for remove comment. The required URL and method that must be included below :
- Method: DELETE
- Request URL: https://tadapipes.tadabase.io/proxy/todoist/comment/{id}
Parameters
Set required Parameters must be included in parameters tab.
- Comment id - (Required)
Headers
There are 2 header Parameters must be required.
Test
Now You can test this API call directly within the API Call test tab. comment id must not be blank for remove a comment and returns an empty response. Successful response has 204 No Content
status.
Response
Here data mapping is not possible because of returns an empty response.
Label
- Create a Label
- View a Label
- Update a Label
- Delete a Label
Create a Label
Allow to create a label.
URL
First you can pass a URL and Method in the overview tab for create a label. The required URL and method that must be included below :
- Method: POST
- Request URL: https://tadapipes.tadabase.io/proxy/todoist/labels
Parameters
Set required Parameters must be included in parameters tab.
- Name - name of Label (Required)
Headers
There are 3 header Parameters must be required.
- Auth-Id ( X-Request-Id )
- Authorization
- Content-Type - application/json
Request
Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for create a label. Here {name} is assign parameter.
Test
Now You can test this API call directly within the API Call test tab. Name must not be blank for create new label and Successful response has 200 Ok
status.
Response
Built in responses already added are below.
- ID
- Name
- Order
- Favorite
View a Label
Allow to returns an label by id.
URL
First you can pass a URL and Method in the overview tab for details of label. The required URL and method that must be included below :
- Method: GET
- Request URL: https://tadapipes.tadabase.io/proxy/todoist/labels/{id}
Parameters
Set required Parameters must be included in parameters tab.
- Label id - (Required)
Headers
There are 1 header Parameters must be included below.
Test
Now You can test this API call directly within the API Call test tab. Label id must be required for getting details of label. Successful response has 200 OK
status.
Response
Built in responses already added are below.
- ID
- Name
- Order
- Favorite
Update a Label
Allow to update a label by id.
URL
First you can pass a URL and Method in the overview tab for update a Label. The required URL and method that must be included below :
- Method : POST
- Request URL : https://tadapipes.tadabase.io/proxy/todoist/labels/{id}
Parameters
Set required parameters must be included in parameters tab.
- Label id - (Required)
- Name - name of label(Required)
Headers
There are 3 header Parameters must be required.
- Auth-Id ( X-Request-Id )
- Authorization
- Content-Type - application/json
Request
Now assigned dynamic parameters in a JSON object in the request tab with the data you want to use for updating label. Here {name} is assign parameter.
Test
Now You can test this API call directly within the API Call test tab. Label id and Name must be required for update label. Successful response has 204 No Content
status.
Response
Here data mapping is not possible because of successful response has an empty body and 204 No Content
status.
Delete a Label
Allow to delete a label by id.
URL
First you can pass a URL and Method in the overview tab for remove label. The required URL and method that must be included below :
- Method: DELETE
- Request URL: https://tadapipes.tadabase.io/proxy/todoist/labels/{id}
Parameters
Set required Parameters must be included in parameters tab.
- Label id - (Required)
Headers
There are 2 header Parameters must be required.
Test
Now You can test this API call directly within the API Call test tab. Label id must not be blank for remove a label and returns an empty response. Successful response has 204 No Content
status.
Response
Here data mapping is not possible because of returns an empty response.
More Details
To learn more about this Pipe and the additional API Methods, please see this article: https://developer.todoist.com/rest/v1/