Skip to content

docs(api): update JSON-RPC response examples #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fguillot merged 1 commit into from
Nov 12, 2026
Merged

docs(api): update JSON-RPC response examples #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions content/en/v1/api/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,10 @@ 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
55 changes: 36 additions & 19 deletions content/en/v1/api/column_procedures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,33 +28,48 @@ Request example:
}
```

Response example:
Response example (Kanboard 1.2.54, PostgreSQL 17, PHP 8.4):

```json
{
"jsonrpc": "2.0",
"id": 887036325,
"result": [
{
"id": "1",
"id": 1,
"title": "Backlog",
"position": "1",
"project_id": "1",
"task_limit": "0"
"position": 1,
"project_id": 1,
"task_limit": 0,
"description": "",
"hide_in_dashboard": false
},
{
"id": "2",
"id": 2,
"title": "Ready",
"position": "2",
"project_id": "1",
"task_limit": "0"
"position": 2,
"project_id": 1,
"task_limit": 0,
"description": "",
"hide_in_dashboard": false
},
{
"id": "3",
"id": 3,
"title": "Work in progress",
"position": "3",
"project_id": "1",
"task_limit": "0"
"position": 3,
"project_id": 1,
"task_limit": 0,
"description": "",
"hide_in_dashboard": false
},
{
"id": 4,
"title": "Done",
"position": 4,
"project_id": 1,
"task_limit": 0,
"description": "",
"hide_in_dashboard": false
}
]
}
Expand Down Expand Up @@ -82,18 +97,20 @@ Request example:
}
```

Response example:
Response example (Kanboard 1.2.54, PostgreSQL 17, PHP 8.4):

```json
{
"jsonrpc": "2.0",
"id": 1242049935,
"result": {
"id": "2",
"title": "Youpi",
"position": "2",
"project_id": "1",
"task_limit": "5"
"id": 1,
"title": "Backlog",
"position": 1,
"project_id": 1,
"task_limit": 0,
"description": "",
"hide_in_dashboard": false
}
}
```
Expand Down
20 changes: 12 additions & 8 deletions content/en/v1/api/comment_procedures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ getAllComments
- Parameters:
- **task_id** (integer, required)
- Result on success: **List of comments**
- Result on failure: **false**
- When no comments are found, the result is an **empty array** (`[]`).

Request example:

Expand All @@ -106,21 +106,25 @@ Request example:
}
```

Response example:
Response example (Kanboard 1.2.54, PostgreSQL 17, PHP 8.4):

```json
{
"jsonrpc": "2.0",
"id": 148484683,
"result": [
{
"id": "1",
"date_creation": "1410882272",
"task_id": "1",
"user_id": "1",
"comment": "Comment #1",
"id": 1,
"date_creation": 1794435903,
"date_modification": 1794435903,
"task_id": 1,
"user_id": 1,
"comment": "Example comment",
"visibility": "app-user",
"username": "admin",
"name": null
"name": null,
"email": null,
"avatar_path": null
}
]
}
Expand Down
22 changes: 11 additions & 11 deletions content/en/v1/api/external_task_link_procedures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,26 +180,26 @@ Request example:
{"jsonrpc":"2.0","method":"getAllExternalTaskLinks","id":2069307223,"params":[9]}
```

Response example:
Response example (Kanboard 1.2.54, PostgreSQL 17, PHP 8.4):

```json
{
"jsonrpc": "2.0",
"result": [
{
"id": "1",
"link_type": "attachment",
"id": 1,
"link_type": "weblink",
"dependency": "related",
"title": "New title",
"url": "http:\/\/localhost\/document.pdf",
"date_creation": "1466965256",
"date_modification": "1466965256",
"task_id": "9",
"creator_id": "0",
"title": "Example",
"url": "https://example.com/",
"date_creation": 1700000000,
"date_modification": 1700000000,
"task_id": 1,
"creator_id": 1,
"creator_name": null,
"creator_username": null,
"creator_username": "admin",
"dependency_label": "Related",
"type": "Attachment"
"type": "Web Link"
}
],
"id": 2069307223
Expand Down
26 changes: 16 additions & 10 deletions content/en/v1/api/internal_task_link_procedures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,26 +139,32 @@ Request example:
}
```

Response example:
Response example (Kanboard 1.2.54, PostgreSQL 17, PHP 8.4):

```json
{
"jsonrpc": "2.0",
"id": 810848359,
"result": [
{
"id": "1",
"task_id": "3",
"id": 1,
"task_id": 2,
"label": "relates to",
"title": "B",
"is_active": "1",
"project_id": "1",
"task_time_spent": "0",
"task_time_estimated": "0",
"task_assignee_id": "0",
"title": "Related task",
"is_active": true,
"project_id": 1,
"column_id": 1,
"color_id": "yellow",
"date_completed": null,
"date_started": 0,
"date_due": 0,
"task_time_spent": null,
"task_time_estimated": null,
"task_assignee_id": 0,
"task_assignee_username": null,
"task_assignee_name": null,
"column_title": "Backlog"
"column_title": "Backlog",
"project_name": "API check"
}
]
}
Expand Down
69 changes: 41 additions & 28 deletions content/en/v1/api/project_procedures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,28 +69,36 @@ Request example:
}
```

Response example:
Response example (Kanboard 1.2.54, PostgreSQL 17, PHP 8.4):

```json
{
"jsonrpc": "2.0",
"id": 226760253,
"result": {
"id": "1",
"name": "API test",
"is_active": "1",
"id": 1,
"name": "API check",
"is_active": true,
"token": "",
"last_modified": "1436119135",
"is_public": "0",
"is_private": "0",
"default_swimlane": "Default swimlane",
"show_default_swimlane": "1",
"description": "test",
"last_modified": 1794435881,
"is_public": false,
"is_private": false,
"description": null,
"identifier": "",
"start_date": "",
"end_date": "",
"owner_id": 1,
"priority_default": 0,
"priority_start": 0,
"priority_end": 3,
"email": null,
"predefined_email_subjects": null,
"per_swimlane_task_limits": false,
"task_limit": 0,
"enable_global_tags": true,
"url": {
"board": "http:\/\/127.0.0.1:8000\/?controller=board&action=show&project_id=1",
"calendar": "http:\/\/127.0.0.1:8000\/?controller=calendar&action=show&project_id=1",
"list": "http:\/\/127.0.0.1:8000\/?controller=listing&action=show&project_id=1"
"board": "http://localhost/?controller=BoardViewController&action=show&project_id=1",
"list": "http://localhost/?controller=TaskListController&action=show&project_id=1"
}
}
}
Expand Down Expand Up @@ -138,7 +146,6 @@ Response example:
"identifier": "",
"url": {
"board": "http:\/\/127.0.0.1:8000\/?controller=board&action=show&project_id=1",
"calendar": "http:\/\/127.0.0.1:8000\/?controller=calendar&action=show&project_id=1",
"list": "http:\/\/127.0.0.1:8000\/?controller=listing&action=show&project_id=1"
}
}
Expand Down Expand Up @@ -187,7 +194,6 @@ Response example:
"identifier": "TEST",
"url": {
"board": "http:\/\/127.0.0.1:8000\/?controller=board&action=show&project_id=1",
"calendar": "http:\/\/127.0.0.1:8000\/?controller=calendar&action=show&project_id=1",
"list": "http:\/\/127.0.0.1:8000\/?controller=listing&action=show&project_id=1"
}
}
Expand Down Expand Up @@ -237,7 +243,6 @@ Response example:
"email": "my_project@my_domain.tld",
"url": {
"board": "http:\/\/127.0.0.1:8000\/?controller=board&action=show&project_id=1",
"calendar": "http:\/\/127.0.0.1:8000\/?controller=calendar&action=show&project_id=1",
"list": "http:\/\/127.0.0.1:8000\/?controller=listing&action=show&project_id=1"
}
}
Expand All @@ -263,29 +268,37 @@ Request example:
}
```

Response example:
Response example (Kanboard 1.2.54, PostgreSQL 17, PHP 8.4):

```json
{
"jsonrpc": "2.0",
"id": 2134420212,
"result": [
{
"id": "1",
"name": "API test",
"is_active": "1",
"id": 1,
"name": "API check",
"is_active": true,
"token": "",
"last_modified": "1436119570",
"is_public": "0",
"is_private": "0",
"default_swimlane": "Default swimlane",
"show_default_swimlane": "1",
"last_modified": 1794435881,
"is_public": false,
"is_private": false,
"description": null,
"identifier": "",
"start_date": "",
"end_date": "",
"owner_id": 1,
"priority_default": 0,
"priority_start": 0,
"priority_end": 3,
"email": null,
"predefined_email_subjects": null,
"per_swimlane_task_limits": false,
"task_limit": 0,
"enable_global_tags": true,
"url": {
"board": "http:\/\/127.0.0.1:8000\/?controller=board&action=show&project_id=1",
"calendar": "http:\/\/127.0.0.1:8000\/?controller=calendar&action=show&project_id=1",
"list": "http:\/\/127.0.0.1:8000\/?controller=listing&action=show&project_id=1"
"board": "http://localhost/?controller=BoardViewController&action=show&project_id=1",
"list": "http://localhost/?controller=TaskListController&action=show&project_id=1"
}
}
]
Expand Down
14 changes: 8 additions & 6 deletions content/en/v1/api/swimlane_procedures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,18 +118,20 @@ Request example:
}
```

Response example:
Response example (Kanboard 1.2.54, PostgreSQL 17, PHP 8.4):

```json
{
"jsonrpc": "2.0",
"id": 131071870,
"result": {
"id": "1",
"name": "Swimlane 1",
"position": "1",
"is_active": "1",
"project_id": "1"
"id": 1,
"name": "Default swimlane",
"position": 1,
"is_active": true,
"project_id": 1,
"description": "",
"task_limit": 0
}
}
```
Expand Down
Loading
Loading