Json-RPC API ============ Protocol -------- Kanboard use 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](http://www.jsonrpc.org/specification). You must call the API with a `POST` HTTP request. Credentials ----------- The API credentials are available on the settings page. - API end-point: `http://YOUR_SERVER/jsonrpc.php` - Username: `jsonrpc` - Password: Random token (API token on the settings page) The API use the [HTTP Basic Authentication Scheme described in the RFC2617](http://www.ietf.org/rfc/rfc2617.txt). If there is an authentication error, you got an HTTP status code `401 Not Authorized`. Examples -------- ### Example with cURL From the command line: ```bash curl \ -u "jsonrpc:19ffd9709d03ce50675c3a43d1c49c1ac207f4bc45f06c5b2701fbdf8929" \ -d '{"jsonrpc": "2.0", "method": "getAllProjects", "id": 1}' \ http://localhost/kanboard/jsonrpc.php ``` Response from the server: ```json { "jsonrpc":"2.0", "id":1, "result":[ { "id":"1", "name":"API test", "is_active":"1", "token":"6bd0932fe7f4b5e6e4bc3c72800bfdef36a2c5de2f38f756dfb5bd632ebf", "last_modified":"1403392631" } ] } ``` ### Example with a PHP client: I wrote a simple [Json-RPC Client/Server library in PHP](https://github.com/fguillot/JsonRPC), here an example: ```php authentication('jsonrpc', '19ffd9709d03ce50675c3a43d1c49c1ac207f4bc45f06c5b2701fbdf8929'); print_r($client->getAllProjects()); ``` The response: ``` Array ( [0] => Array ( [id] => 1 [name] => API test [is_active] => 1 [token] => 6bd0932fe7f4b5e6e4bc3c72800bfdef36a2c5de2f38f756dfb5bd632ebf [last_modified] => 1403392631 ) ) ``` Procedures ---------- ### createProject - Purpose: **Create a new project** - Parameters: - **name** (string, required) - Result on success: **true** - Result on failure: **false** Request example: ```json { "jsonrpc": "2.0", "method": "createProject", "id": 1797076613, "params": { "name": "PHP client" } } ``` Response example: ```json { "jsonrpc": "2.0", "id": 1797076613, "result": true } ``` ### getProjectById - Purpose: **Get project information** - Parameters: - **project_id** (integer, required) - Result on success: **project properties** - Result on failure: **null** Request example: ```json { "jsonrpc": "2.0", "method": "getProjectById", "id": 226760253, "params": { "project_id": 1 } } ``` Response example: ```json { "jsonrpc": "2.0", "id": 226760253, "result": { "id": "1", "name": "API test", "is_active": "1", "token": "", "last_modified": "1410263246", "is_public": "0" } } ``` ### getProjectByName - Purpose: **Get project information** - Parameters: **name** (string) - Result on success: **project properties** - Result on failure: **null** Request example: ```json { "jsonrpc": "2.0", "method": "getProjectByName", "id": 1620253806, "params": { "name": "Test" } } ``` Response example: ```json { "jsonrpc": "2.0", "id": 1620253806, "result": { "id": "1", "name": "Test", "is_active": "1", "token": "", "last_modified": "0", "is_public": "0" } } ``` ### getAllProjects - Purpose: **Get all available projects** - Parameters: **none** - Result on success: **List of projects** - Result on failure: **false** Request example: ```json { "jsonrpc": "2.0", "method": "getAllProjects", "id": 134982303 } ``` Response example: ```json { "jsonrpc": "2.0", "id": 134982303, "result": [ { "id": "2", "name": "PHP client", "is_active": "1", "token": "", "last_modified": "0", "is_public": "0" }, { "id": "1", "name": "Test", "is_active": "1", "token": "", "last_modified": "0", "is_public": "0" } ] } ``` ### updateProject - Purpose: **Update a project** - Parameters: - **id** (integer, required) - **name** (string, required) - **is_active** (integer, optional) - **token** (string, optional) - **is_public** (integer, optional) - Result on success: **true** - Result on failure: **false** Request example: ```json { "jsonrpc": "2.0", "method": "updateProject", "id": 1853996288, "params": { "id": 1, "name": "PHP client update" } } ``` Response example: ```json { "jsonrpc": "2.0", "id": 1853996288, "result": true } ``` ### removeProject - Purpose: **Remove a project** - Parameters: **project_id** (integer, required) - Result on success: **true** - Result on failure: **false** Request example: ```json { "jsonrpc": "2.0", "method": "removeProject", "id": 46285125, "params": { "project_id": "2" } } ``` Response example: ```json { "jsonrpc": "2.0", "id": 46285125, "result": true } ``` ### enableProject - Purpose: **Enable a project** - Parameters: - **project_id** (integer, required) - Result on success: **true** - Result on failure: **false** Request example: ```json { "jsonrpc": "2.0", "method": "enableProject", "id": 1775494839, "params": [ "1" ] } ``` Response example: ```json { "jsonrpc": "2.0", "id": 1775494839, "result": true } ``` ### disableProject - Purpose: **Disable a project** - Parameters: - **project_id** (integer, required) - Result on success: **true** - Result on failure: **false** Request example: ```json { "jsonrpc": "2.0", "method": "disableProject", "id": 1734202312, "params": [ "1" ] } ``` Response example: ```json { "jsonrpc": "2.0", "id": 1734202312, "result": true } ``` ### enableProjectPublicAccess - Purpose: **Enable public access for a given project** - Parameters: - **project_id** (integer, required) - Result on success: **true** - Result on failure: **false** Request example: ```json { "jsonrpc": "2.0", "method": "enableProjectPublicAccess", "id": 103792571, "params": [ "1" ] } ``` Response example: ```json { "jsonrpc": "2.0", "id": 103792571, "result": true } ``` ### disableProjectPublicAccess - Purpose: **Disable public access for a given project** - Parameters: - **project_id** (integer, required) - Result on success: **true** - Result on failure: **false** Request example: ```json { "jsonrpc": "2.0", "method": "disableProjectPublicAccess", "id": 942472945, "params": [ "1" ] } ``` Response example: ```json "jsonrpc": "2.0", "id": 942472945, "result": true } ``` ### getBoard - Purpose: **Get all necessary information to display a board** - Parameters: **project_id** (integer) - Result on success: **board properties** - Result on failure: **null** ### getColumns - Purpose: **Get all columns information for a given project** - Parameters: **project_id** (integer) - Result on success: **columns properties** - Result on failure: **null** ### moveColumnUp - Purpose: **Move up the column position** - Parameters: **project_id** (integer), **column_id** (integer) - Result on success: **true** - Result on failure: **false** ### moveColumnDown - Purpose: **Move down the column position** - Parameters: **project_id** (integer), **column_id** (integer) - Result on success: **true** - Result on failure: **false** ### updateColumn - Purpose: **Update column properties** - Parameters: **column_id** (integer), **values** (**title** string, **task_limit** integer) - Result on success: **true** - Result on failure: **false** ### addColumn - Purpose: **Add a new column** - Parameters: **project_id** (integer), **values** (**title** string, **task_limit** integer) - Result on success: **true** - Result on failure: **false** ### removeColumn - Purpose: **Remove a column** - Parameters: **column_id** (integer) - Result on success: **true** - Result on failure: **false** ### getAllowedUsers - Purpose: **Get allowed users for a given project** - Parameters: **project_id** (integer) - Result on success: Key/value pair of user_id and username - Result on failure: **false** ### revokeUser - Purpose: **Revoke user access for a given project** - Parameters: **project_id** (integer), **user_id** (integer) - Result on success: **true** - Result on failure: **false** ### allowUser - Purpose: **Grant user access for a given project** - Parameters: **project_id** (integer), **user_id** (integer) - Result on success: **true** - Result on failure: **false** ### createTask - Purpose: **Create a new task** - Parameters: - **title** (string, required) - **project_id** (integer, required) - **color_id** (string, optional) - **column_id** (integer, optional) - **description** (string, optional) - **owner_id** (integer, optional) - **creator_id** (integer, optional) - **score** (integer, optional) - **date_due**: ISO8601 format (string, optional) - **category_id** (integer, optional) - Result on success: **true** - Result on failure: **false** Request example: ```json { "jsonrpc": "2.0", "method": "createTask", "id": 1176509098, "params": { "owner_id": 1, "creator_id": 0, "date_due": "", "description": "", "category_id": 0, "score": 0, "title": "Test", "project_id": 1, "color_id": "green", "column_id": 2 } } ``` Response example: ```json { "jsonrpc": "2.0", "id": 1176509098, "result": true } ``` ### getTask - Purpose: **Get task information** - Parameters: - **task_id** (integer, required) - Result on success: **task properties** - Result on failure: **null** Request example: ```json { "jsonrpc": "2.0", "method": "getTask", "id": 700738119, "params": { "task_id": 1 } } ``` Response example: ```json { "jsonrpc": "2.0", "id": 700738119, "result": { "id": "1", "title": "Task #1", "description": "", "date_creation": "1409963206", "color_id": "blue", "project_id": "1", "column_id": "2", "owner_id": "1", "position": "1", "is_active": "1", "date_completed": null, "score": "0", "date_due": "0", "category_id": "0", "creator_id": "0", "date_modification": "1409963206" } } ``` ### getAllTasks - Purpose: **Get all available tasks** - Parameters: - **project_id** (integer, required) - **status**: List of status id, the value 1 for active tasks and 0 for inactive (list, required) - Result on success: **List of tasks** - Result on failure: **false** Request example to fetch all tasks on the board: ```json { "jsonrpc": "2.0", "method": "getAllTasks", "id": 133280317, "params": { "project_id": 1, "status": [ 1 ] } } ``` Response example: ```json { "jsonrpc": "2.0", "id": 133280317, "result": [ { "id": "1", "title": "Task #1", "description": "", "date_creation": "1409961789", "color_id": "blue", "project_id": "1", "column_id": "2", "owner_id": "1", "position": "1", "is_active": "1", "date_completed": null, "score": "0", "date_due": "0", "category_id": "0", "creator_id": "0", "date_modification": "1409961789" }, { "id": "2", "title": "Test", "description": "", "date_creation": "1409962115", "color_id": "green", "project_id": "1", "column_id": "2", "owner_id": "1", "position": "2", "is_active": "1", "date_completed": null, "score": "0", "date_due": "0", "category_id": "0", "creator_id": "0", "date_modification": "1409962115" }, ... ] } ``` ### updateTask - Purpose: **Update a task** - Parameters: - **id** (integer, required) - **title** (string, optional) - **color_id** (string, optional) - **project_id** (integer, optional) - **column_id** (integer, optional) - **description** (string, optional) - **owner_id** (integer, optional) - **creator_id** (integer, optional) - **score** (integer, optional) - **date_due**: ISO8601 format (string, optional) - **category_id** (integer, optional) - Result on success: **true** - Result on failure: **false** Request example to change the task color: ```json { "jsonrpc": "2.0", "method": "updateTask", "id": 1406803059, "params": { "id": 1, "color_id": "blue" } } ``` Response example: ```json { "jsonrpc": "2.0", "id": 1406803059, "result": true } ``` ### openTask - Purpose: **Set a task to the status open** - Parameters: - **task_id** (integer, required) - Result on success: **true** - Result on failure: **false** Request example: ```json { "jsonrpc": "2.0", "method": "openTask", "id": 1888531925, "params": { "task_id": 1 } } ``` Response example: ```json { "jsonrpc": "2.0", "id": 1888531925, "result": true } ``` ### closeTask - Purpose: **Set a task to the status close** - Parameters: - **task_id** (integer, required) - Result on success: **true** - Result on failure: **false** Request example: ```json { "jsonrpc": "2.0", "method": "closeTask", "id": 1654396960, "params": { "task_id": 1 } } ``` Response example: ```json { "jsonrpc": "2.0", "id": 1654396960, "result": true } ``` ### removeTask - Purpose: **Remove a task** - Parameters: - **task_id** (integer, required) - Result on success: **true** - Result on failure: **false** Request example: ```json { "jsonrpc": "2.0", "method": "removeTask", "id": 1423501287, "params": { "task_id": 1 } } ``` Response example: ```json { "jsonrpc": "2.0", "id": 1423501287, "result": true } ``` ### moveTaskPosition - Purpose: **Move a task to another column or another position** - Parameters: - **project_id** (integer, required) - **task_id** (integer, required) - **column_id** (integer, required) - **position** (integer, required) - Result on success: **true** - Result on failure: **false** Request example: ```json { "jsonrpc": "2.0", "method": "moveTaskPosition", "id": 117211800, "params": { "project_id": 1, "task_id": 1, "column_id": 2, "position": 1 } } ``` Response example: ```json { "jsonrpc": "2.0", "id": 117211800, "result": true } ``` ### createUser - Purpose: **Create a new user** - Parameters: Key/value pair composed of the **username** (string), **password** (string), **confirmation** (string), **name** (string, optional), **email** (string, optional), is_admin (integer, optional), **default_project_id** (integer, optional) - Result on success: **true** - Result on failure: **false** ### getUser - Purpose: **Get user information** - Parameters: **user_id** (integer) - Result on success: **user properties** - Result on failure: **null** ### getAllUsers - Purpose: **Get all available users** - Parameters: **none** - Result on success: **List of users** - Result on failure: **false** ### updateUser - Purpose: **Update a user** - Parameters: Key/value pair composed of the **id** (integer), **username** (string), **password** (string), **confirmation** (string), **name** (string, optional), **email** (string, optional), is_admin (integer, optional), **default_project_id** (integer, optional) - Result on success: **true** - Result on failure: **false** ### removeUser - Purpose: **Remove a user** - Parameters: **user_id** (integer) - Result on success: **true** - Result on failure: **false** ### createCategory - Purpose: **Create a new category** - Parameters: Key/value pair composed of the **name** (string), **project_id** (integer) - Result on success: **true** - Result on failure: **false** ### getCategory - Purpose: **Get category information** - Parameters: **category_id** (integer) - Result on success: **category properties** - Result on failure: **null** ### getAllCategories - Purpose: **Get all available categories** - Parameters: **project_id** (integer) - Result on success: **List of categories** - Result on failure: **false** ### updateCategory - Purpose: **Update a category** - Parameters: Key/value pair composed of the **id** (integer), **name** (string), **project_id** (integer) - Result on success: **true** - Result on failure: **false** ### removeCategory - Purpose: **Remove a category** - Parameters: **category_id** (integer) - Result on success: **true** - Result on failure: **false** ### createComment - Purpose: **Create a new comment** - Parameters: Key/value pair composed of the **task_id** (integer), **user_id** (integer), **comment** (string) - Result on success: **true** - Result on failure: **false** ### getComment - Purpose: **Get comment information** - Parameters: **comment_id** (integer) - Result on success: **comment properties** - Result on failure: **null** ### getAllComments - Purpose: **Get all available comments** - Parameters: **none** - Result on success: **List of comments** - Result on failure: **false** ### updateComment - Purpose: **Update a comment** - Parameters: Key/value pair composed of the **id** (integer), **task_id** (integer), **user_id** (integer), **comment** (string) - Result on success: **true** - Result on failure: **false** ### removeComment - Purpose: **Remove a comment** - Parameters: **comment_id** (integer) - Result on success: **true** - Result on failure: **false** ### createSubtask - Purpose: **Create a new subtask** - Parameters: Key/value pair composed of the **title** (integer), time_estimated (int, optional), task_id (int), user_id (int, optional) - Result on success: **true** - Result on failure: **false** ### getSubtask - Purpose: **Get subtask information** - Parameters: **subtask_id** (integer) - Result on success: **subtask properties** - Result on failure: **null** ### getAllSubtasks - Purpose: **Get all available subtasks** - Parameters: **none** - Result on success: **List of subtasks** - Result on failure: **false** ### updateSubtask - Purpose: **Update a subtask** - Parameters: Key/value pair composed of the **id** (integer), **title** (integer), status (integer, optional) time_estimated (int, optional), time_spent (int, optional), task_id (int), user_id (int, optional) - Result on success: **true** - Result on failure: **false** ### removeSubtask - Purpose: **Remove a subtask** - Parameters: **subtask_id** (integer) - Result on success: **true** - Result on failure: **false**