Todoist API TypeScript Client

This is the official TypeScript API client for the Todoist REST API.

Installation

npm install @doist/todoist-api-typescript

Usage

An example of initializing the API client and fetching a user's tasks:

import { TodoistApi } from '@doist/todoist-api-typescript'

const api = new TodoistApi('YOURTOKEN')

api.getTasks()
    .then((tasks) => console.log(tasks))
    .catch((error) => console.log(error))

Documentation

For more detailed reference documentation, have a look at the Todoist API v1 Documentation.

Migration Guide

If you're migrating from an older version of the Todoist API (v9), please refer to the official migration guide for detailed information about the changes and breaking updates.

Key changes in v1 include:

• Updated endpoint structure
• New pagination system
• Unified error response format
• Object renames (e.g., items → tasks, notes → comments)
• URL renames and endpoint signature changes

Custom HTTP Clients

The Todoist API client supports custom HTTP implementations to enable usage in environments with specific networking requirements, such as:

• Obsidian plugins - Desktop app with strict CORS policies
• Browser extensions - Custom HTTP APIs with different security models
• Electron apps - Requests routed through IPC layer
• React Native - Different networking stack
• Enterprise environments - Proxy configuration, custom headers, or certificate handling

Basic Usage

import { TodoistApi } from '@doist/todoist-api-typescript'

// Using the new options-based constructor
const api = new TodoistApi('YOURTOKEN', {
    baseUrl: 'https://custom-api.example.com', // optional
    customFetch: myCustomFetch, // your custom fetch implementation
})

// Legacy constructor (deprecated but supported)
const apiLegacy = new TodoistApi('YOURTOKEN', 'https://custom-api.example.com')

Custom Fetch Interface

Your custom fetch function must implement this interface:

type CustomFetch = (
    url: string,
    options?: RequestInit & { timeout?: number },
) => Promise<CustomFetchResponse>

type CustomFetchResponse = {
    ok: boolean
    status: number
    statusText: string
    headers: Record<string, string>
    text(): Promise<string>
    json(): Promise<unknown>
}

OAuth with Custom Fetch

OAuth authentication functions (getAuthToken, revokeAuthToken, revokeToken) support custom fetch through an options object:

// New options-based usage
const { accessToken } = await getAuthToken(args, {
    baseUrl: 'https://custom-auth.example.com',
    customFetch: myCustomFetch,
})

await revokeToken(args, {
    customFetch: myCustomFetch,
})

// Legacy usage (deprecated)
const { accessToken } = await getAuthToken(args, baseUrl)

Important Notes

• All existing transforms (snake_case ↔ camelCase) work automatically with custom fetch
• Retry logic and error handling are preserved
• File uploads work with custom fetch implementations
• The custom fetch function should handle FormData for multipart uploads
• Timeout parameter is optional and up to your custom implementation

Development and Testing

Instead of having an example app in the repository to assist development and testing, we have included ts-node as a dev dependency. This allows us to have a scratch file locally that can import and utilize the API while developing or reviewing pull requests without having to manage a separate app project.

• npm install
• Add a file named scratch.ts in the src folder.
• Configure your IDE to run the scratch file with ts-node (instructions for VSCode, WebStorm), or you can optionally run ts-node in a terminal using instructions here (npx ts-node ./src/scratch.ts should be enough).
• Import and call the relevant modules and run the scratch file.

Example scratch.ts file:

/* eslint-disable no-console */
import { TodoistApi } from './todoist-api'

const token = 'YOURTOKEN'
const api = new TodoistApi(token)

api.getProjects()
    .then((projects) => {
        console.log(projects)
    })
    .catch((error) => console.error(error))

Local API Requests With .env

For live API verification, you can run raw requests with a local token:

1. Copy .env.example to .env.
2. Set TODOIST_API_TOKEN in .env.
3. Run requests with npm run api:request -- ....
4. Optional: set TODOIST_API_BASE_URL in .env (defaults to https://api.todoist.com).

Examples:

npm run api:request -- --path /api/v1/tasks
npm run api:request -- --method POST --path /api/v1/tasks --body '{"content":"API smoke test"}'
npm run api:request -- --method POST --path /api/v1/tasks/123 --body '{"due_string":"no date"}'
npm run api:request -- --path /api/v1/tasks --query '{"project_id":"123","limit":10}'

To see all options:

npm run api:request -- --help

Releases

This project uses Release Please to automate releases. Releases are created automatically based on Conventional Commits.

For Contributors

When making changes, use conventional commit messages:

• feat: - New features (triggers a minor version bump)
• fix: - Bug fixes (triggers a patch version bump)
• feat!: or BREAKING CHANGE: - Breaking changes (triggers a major version bump)
• chore:, docs:, refactor:, perf: - Other changes (included in changelog)

Example:

feat: add support for recurring tasks
fix: resolve issue with date parsing
feat!: remove deprecated getTask method

For Maintainers

The release process is fully automated:

1. Automatic PR Creation: When commits are merged to main, Release Please automatically creates or updates a release PR with:

   • Updated version in package.json
   • Updated CHANGELOG.md
   • Aggregated changes since the last release

2. Review and Merge: Review the release PR to ensure the version bump and changelog are correct, then merge it.

3. Automatic Release: Upon merging the release PR:

   • A GitHub release is automatically created with the new version tag
   • The publish.yml workflow is triggered by the tag
   • The package is automatically published to NPM

Users of the API client can then update to the new version in their package.json.

Feedback

Any feedback, such as bugs, questions, comments, etc. can be reported as Issues in this repository, and will be handled by us in Todoist.

Contributions

We would also love contributions in the form of Pull requests in this repository.