API Reference

Introduction

User and application API

There are two types of API access:

Application API

User API

Security

Since Kanboard v1.2.8, people with two-factor authentication enabled must use API keys.

Protocol

Kanboard uses the protocol Json-RPC to interact with external programs.

JSON-RPC is a remote procedure call protocol encoded in JSON. Almost the same thing as XML-RPC but with the JSON format.

We use the version 2 of the protocol. You must call the API with a POST HTTP request.

Kanboard support batch requests, so you can make multiple API calls in a single HTTP request. It’s particularly useful for mobile clients with higher network latency.

API Procedures