API Reference
Introduction
There are two types of API access:
Application API
- Access the API with the user “jsonrpc” and the token available on the settings page.
- Access all procedures.
- No permissions are checked.
- There is no user session on the server.
- No access to procedures that start with “My…” (e.g., “getMe” or “getMyProjects”).
- Example of possible clients: tools to migrate/import data, create tasks from another system, etc.
User API
- Access the API with user credentials (username and password).
- You can also generate a personal access token instead of your password.
- Application roles and project permissions are checked for each procedure.
- A user session is created on the server.
- Example of possible clients: native mobile/desktop applications, command-line utilities, etc.
Security
- Always use HTTPS with a valid certificate (avoid clear-text communication).
- If you develop a mobile application, it’s your responsibility to store user credentials securely on the device.
- After three authentication failures on the user API, the end-user must unlock their account using the login form.
Protocol
Kanboard uses the JSON-RPC protocol to interact with external programs.
JSON-RPC is a remote procedure call protocol encoded in JSON. It is similar to XML-RPC but uses the JSON format.
Kanboard uses version 2 of the protocol.
You must call the API with a POST HTTP request.
Kanboard supports batch requests, allowing you to make multiple API calls in a single HTTP request. This is particularly useful for mobile clients with higher network latency.
Response examples illustrate the structure of the returned data. Some examples show database values
as JSON strings, while an actual response can contain numbers or booleans instead. Responses can also
include fields not shown in an example. Check the response from your Kanboard installation when
building clients that require fixed JSON types. For example, a task’s is_active field may be a
boolean with PostgreSQL or an integer with SQLite.
API Procedures
- API Authentication
- API Examples
- Application API Procedures
- Automatic Actions API Procedures
- Board API Procedures
- Category API Procedures
- Column API Procedures
- Comment API Procedures
- Current User API Procedures
- External Task Link API Procedures
- Group API Procedures
- Group Member API Procedures
- Internal Task Link API Procedures
- Link API Procedures
- Project API Procedures
- Project File API Procedures
- Project Metadata API Procedures
- Project Permission API Procedures
- Subtask API Procedures
- Subtask Time Tracking API Procedures
- Swimlane API Procedures
- Tags API Procedures
- Task API Procedures
- Task File API Procedures
- Task Metadata API Procedures
- User API Procedures