api

todoist-api-go

This repository provides a Go library that implements Todoist API v1.

📦 Packages

• Package todoist implements the base client.

• Package sync defines models and helpers for the Sync API.

• Package rest defines models for the RESTful API.

• Package ws implements a WebSocket client for real-time notifications.

🚧 Implementation Notes

Not all APIs have been implemented. Most of the Sync APIs and a small portion of the RESTful APIs have been implemented.

Feature Status

Sync API

RESTful API

WebSocket API

🧪 Examples

Sync API Basic Usage

token := os.Getenv("API_TOKEN")
cli := todoist.NewClient(http.DefaultClient, token, todoist.DefaultHandler)
taskSvc := todoist.NewTaskService(cli)

_, err := cli.SyncWithAutoToken(context.Background(), true)
if err != nil {
    panic(err)
}

args := &sync.TaskAddArgs{Content: "test"}
_, err = taskSvc.AddTask(context.Background(), args)
if err != nil {
    panic(err)
}

Sync API Multiple Commands

token := os.Getenv("API_TOKEN")
cli := todoist.NewClient(http.DefaultClient, token, todoist.DefaultHandler)

projCmd := sync.NewCommand(&sync.ProjectAddArgs{Name: "test"})

tempID := projCmd.TempID.String()
taskCmd := sync.NewCommand(&sync.TaskAddArgs{Content: "test", ProjectID: &tempID})

_, err := cli.ExecuteCommands(context.Background(), sync.Commands{projCmd, taskCmd})
if err != nil {
    panic(err)
}

RESTful API Basic Usage

token := os.Getenv("API_TOKEN")
cli := todoist.NewClient(http.DefaultClient, token, todoist.DefaultHandler)
taskSvc := todoist.NewTaskService(cli)

req := &rest.TaskQuickAddRequest{Text: "test"}
_, err := taskSvc.QuickAddTask(context.Background(), req)
if err != nil {
    panic(err)
}

Custom Handler

func (h *customHandler) SyncToken(ctx context.Context) (*string, error) {
	// Full sync every time.
	st := sync.DefaultSyncToken
	return &st, nil
}

func (h *customHandler) ResourceTypes(ctx context.Context) (*sync.ResourceTypes, error) {
	// Only sync tasks.
	return &sync.ResourceTypes{sync.Tasks}, nil
}

func (h *customHandler) HandleResponse(ctx context.Context, resp any) error {
	// Print the tasks.
	switch r := resp.(type) {
	case *sync.SyncResponse:
		for _, task := range r.Tasks {
			fmt.Printf("Task ID: %s, Content: %s\n", task.ID, task.Content)
		}
	case *rest.TaskGetCompletedResponse:
		for _, task := range r.Tasks {
			fmt.Printf("Completed Task ID: %s, Content: %s\n", task.ID, task.Content)
		}
	}

	return nil
}

📚 More Examples

You can find more usage examples in todoist-cli, a Todoist CLI client with an integrated WebSocket daemon for real-time syncing.

🔍 Comparison

⭐ Credit

• todoist
• todoist-net