Welcome to the KanbanFlow API

The KanbanFlow API lets you connect your boards to other systems and automate your work. It is a JSON API that you call with regular HTTPS requests, so you can use it from any programming language.

This documentation will help you get started integrating KanbanFlow with external systems. Use the menu to explore the available endpoints and features.

Properties and parameters that are not marked Required are optional.

What you can do with the API

• Read the structure of your board, such as columns, swimlanes and colors, with Get board.
• Find tasks with Get all tasks and Search tasks.
• Create, update and delete tasks.
• Manage subtasks, labels, dates, comments, attachments and relations of a task.
• Track time with manual time entries, and read Stopwatch and Pomodoro entries.
• Follow what happens on the board with board events and task events.
• Get notified directly when something changes on the board with webhooks.

Quick start

First, create an API token as described in Authentication. Then send your first request. This example returns the board that the token belongs to:

curl -H "Authorization: Bearer <SECRET_TOKEN>" https://kanbanflow.com/api/v1/board

The response contains the columns, swimlanes and colors of the board. Use the ID of a column to add a task to it with Create task.

About the code examples

Most examples in this documentation use curl to demonstrate how the API works. Curl is freely available on most platforms and can be downloaded here. However, curl is not required to use the API. Any client or server library capable of sending HTTP requests can be used to communicate with the API.

Instructions for authenticating with the API are provided in the Authentication section. To keep the examples concise, authentication details are not repeated elsewhere in the documentation.

Need help?

We would love to hear from you. Whether you need help using the API or want to suggest a new feature, feel free to email us at support@kanbanflow.com.