From 9ae20a3f51e63c29f536e2f5b3e66a2c7d88c691 Mon Sep 17 00:00:00 2001 From: Lauri Ojansivu Date: Tue, 28 Apr 2020 03:24:18 +0300 Subject: Fix Cards and Users docs not generated because of syntax error and new Javascript syntax. Wekan uses wekan/releases/generate-docs*.sh Python code to generate OpenAPI docs, it did not show any errors while generating docs, only left out parts of API docs. Thanks to pvcon13 and xet7 ! --- public/api/wekan.html | 6356 ++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 5266 insertions(+), 1090 deletions(-) (limited to 'public/api/wekan.html') diff --git a/public/api/wekan.html b/public/api/wekan.html index 49cf0b3b..38188deb 100644 --- a/public/api/wekan.html +++ b/public/api/wekan.html @@ -1458,12 +1458,12 @@ Darkula color scheme from the JetBrains family of IDEs opacity: 0.5; } - + - + @@ -1477,429 +1477,547 @@ var n=this.pipeline.run(e.tokenizer(t)),r=new e.Vector,i=[],o=this._fields.reduc
- +
- - + + Shell - - - + + + HTTP - - - + + + JavaScript - - - + + + Node.js - - - + + + Ruby - - - + + + Python - - - + + + Java - - - + + + Go - - + +
- - + +
- +
- + - +
@@ -2042,7 +2160,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Content-Type": []string{"application/x-www-form-urlencoded"}, "Accept": []string{"*/*"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -2317,7 +2435,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Content-Type": []string{"application/x-www-form-urlencoded"}, "Accept": []string{"*/*"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -2600,7 +2718,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -2806,7 +2924,7 @@ System.out.println(response.toString()); "Content-Type": []string{"multipart/form-data"}, "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -3101,7 +3219,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -3326,7 +3444,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -3488,7 +3606,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -3671,7 +3789,7 @@ System.out.println(response.toString()); "Content-Type": []string{"multipart/form-data"}, "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -3876,7 +3994,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Content-Type": []string{"multipart/form-data"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -4098,7 +4216,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -4303,7 +4421,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -4480,7 +4598,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Content-Type": []string{"multipart/form-data"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -4674,7 +4792,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -4847,7 +4965,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -5021,7 +5139,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -5212,7 +5330,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Content-Type": []string{"multipart/form-data"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -5420,7 +5538,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -5609,7 +5727,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -5840,7 +5958,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Content-Type": []string{"multipart/form-data"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -6034,7 +6152,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -6207,7 +6325,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -6389,7 +6507,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -6622,7 +6740,7 @@ System.out.println(response.toString()); "Content-Type": []string{"multipart/form-data"}, "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -6882,7 +7000,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -7048,7 +7166,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -7223,7 +7341,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -7517,7 +7635,7 @@ System.out.println(response.toString()); "Content-Type": []string{"multipart/form-data"}, "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -7739,7 +7857,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -7951,7 +8069,7 @@ System.out.println(response.toString()); "Content-Type": []string{"multipart/form-data"}, "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -8213,7 +8331,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -8415,7 +8533,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -8591,7 +8709,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Content-Type": []string{"multipart/form-data"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -8786,7 +8904,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -9007,7 +9125,7 @@ System.out.println(response.toString()); "Content-Type": []string{"multipart/form-data"}, "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -9229,7 +9347,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -9432,7 +9550,7 @@ System.out.println(response.toString()); headers := map[string][]string{ "Accept": []string{"application/json"}, "Authorization": []string{"API_KEY"}, - + } data := bytes.NewBuffer([]byte{jsonReq}) @@ -9535,19 +9653,19 @@ The list is not put in the recycle bin.

To perform this operation, you must be authenticated by means of one of the following methods: UserSecurity -

Swimlanes

-

get_all_swimlanes

-

+

Cards

+

get_all_cards

+

Code samples

# You can also use wget
-curl -X GET /api/boards/{board}/swimlanes \
+curl -X GET /api/boards/{board}/lists/{list}/cards \
   -H 'Accept: application/json' \
   -H 'Authorization: API_KEY'
-
GET /api/boards/{board}/swimlanes HTTP/1.1
+
GET /api/boards/{board}/lists/{list}/cards HTTP/1.1
 
 Accept: application/json
 
@@ -9559,7 +9677,7 @@ curl -X GET /api/boards/{board}/swimlanes \
 };
 
 $.ajax({
-  url: '/api/boards/{board}/swimlanes',
+  url: '/api/boards/{board}/lists/{list}/cards',
   method: 'get',
 
   headers: headers,
@@ -9577,7 +9695,7 @@ $.ajax({
 
 };
 
-fetch('/api/boards/{board}/swimlanes',
+fetch('/api/boards/{board}/lists/{list}/cards',
 {
   method: 'GET',
 
@@ -9598,7 +9716,7 @@ headers = {
   'Authorization' => 'API_KEY'
 }
 
-result = RestClient.get '/api/boards/{board}/swimlanes',
+result = RestClient.get '/api/boards/{board}/lists/{list}/cards',
   params: {
   }, headers: headers
 
@@ -9611,14 +9729,14 @@ headers = {
   'Authorization': 'API_KEY'
 }
 
-r = requests.get('/api/boards/{board}/swimlanes', params={
+r = requests.get('/api/boards/{board}/lists/{list}/cards', params={
 
 }, headers = headers)
 
 print r.json()
 
 

-
URL obj = new URL("/api/boards/{board}/swimlanes");
+
URL obj = new URL("/api/boards/{board}/lists/{list}/cards");
 HttpURLConnection con = (HttpURLConnection) obj.openConnection();
 con.setRequestMethod("GET");
 int responseCode = con.getResponseCode();
@@ -9645,11 +9763,11 @@ System.out.println(response.toString());
     headers := map[string][]string{
         "Accept": []string{"application/json"},
         "Authorization": []string{"API_KEY"},
-
+        
     }
 
     data := bytes.NewBuffer([]byte{jsonReq})
-    req, err := http.NewRequest("GET", "/api/boards/{board}/swimlanes", data)
+    req, err := http.NewRequest("GET", "/api/boards/{board}/lists/{list}/cards", data)
     req.Header = headers
 
     client := &http.Client{}
@@ -9658,9 +9776,9 @@ System.out.println(response.toString());
 }
 
 

-
GET /api/boards/{board}/swimlanes

-
Get the list of swimlanes attached to a board

-
Parameters

+
GET /api/boards/{board}/lists/{list}/cards

+
Get all Cards attached to a List

+
Parameters

 
@@ -9677,12 +9795,20 @@ System.out.println(response.toString());
 
-
+
+
+
+
+
+
+
+

 
 
path
 string
 truethe ID of the boardthe board ID
listpathstringtruethe list ID
 

 
 

 
Detailed descriptions

-
board: the ID of the board

+
board: the board ID

+
list: the list ID

 

 
Example responses

 

@@ -9692,11 +9818,12 @@ System.out.println(response.toString());
 
[
   {
     "_id": "string",
-    "title": "string"
+    "title": "string",
+    "description": "string"
   }
 ]
 

-
Responses

+
Responses

 
@@ -9715,7 +9842,7 @@ System.out.println(response.toString());
 

 
 

 
 

-
Response Schema

+
Response Schema

 
Status Code 200

 
@@ -9742,25 +9869,32 @@ System.out.println(response.toString());
 
+
+
+
+
+
+
+

 
none
 none
 
» descriptionstringfalsenonenone

 
 

 
-
new_swimlane

-

+
new_card

+

 

 
Code samples

 

 
# You can also use wget
-curl -X POST /api/boards/{board}/swimlanes \
+curl -X POST /api/boards/{board}/lists/{list}/cards \
   -H 'Content-Type: multipart/form-data' \
   -H 'Accept: application/json' \
   -H 'Authorization: API_KEY'
 
 

-
POST /api/boards/{board}/swimlanes HTTP/1.1
+
POST /api/boards/{board}/lists/{list}/cards HTTP/1.1
 
 Content-Type: multipart/form-data
 Accept: application/json
@@ -9774,7 +9908,7 @@ Accept: application/json
 };
 
 $.ajax({
-  url: '/api/boards/{board}/swimlanes',
+  url: '/api/boards/{board}/lists/{list}/cards',
   method: 'post',
 
   headers: headers,
@@ -9786,7 +9920,12 @@ $.ajax({
 

 
const fetch = require('node-fetch');
 const inputBody = '{
-  "title": "string"
+  "authorId": "string",
+  "members": "string",
+  "assignees": "string",
+  "title": "string",
+  "description": "string",
+  "swimlaneId": "string"
 }';
 const headers = {
   'Content-Type':'multipart/form-data',
@@ -9795,7 +9934,7 @@ $.ajax({
 
 };
 
-fetch('/api/boards/{board}/swimlanes',
+fetch('/api/boards/{board}/lists/{list}/cards',
 {
   method: 'POST',
   body: inputBody,
@@ -9817,7 +9956,7 @@ headers = {
   'Authorization' => 'API_KEY'
 }
 
-result = RestClient.post '/api/boards/{board}/swimlanes',
+result = RestClient.post '/api/boards/{board}/lists/{list}/cards',
   params: {
   }, headers: headers
 
@@ -9831,14 +9970,14 @@ headers = {
   'Authorization': 'API_KEY'
 }
 
-r = requests.post('/api/boards/{board}/swimlanes', params={
+r = requests.post('/api/boards/{board}/lists/{list}/cards', params={
 
 }, headers = headers)
 
 print r.json()
 
 

-
URL obj = new URL("/api/boards/{board}/swimlanes");
+
URL obj = new URL("/api/boards/{board}/lists/{list}/cards");
 HttpURLConnection con = (HttpURLConnection) obj.openConnection();
 con.setRequestMethod("POST");
 int responseCode = con.getResponseCode();
@@ -9866,11 +10005,11 @@ System.out.println(response.toString());
         "Content-Type": []string{"multipart/form-data"},
         "Accept": []string{"application/json"},
         "Authorization": []string{"API_KEY"},
-
+        
     }
 
     data := bytes.NewBuffer([]byte{jsonReq})
-    req, err := http.NewRequest("POST", "/api/boards/{board}/swimlanes", data)
+    req, err := http.NewRequest("POST", "/api/boards/{board}/lists/{list}/cards", data)
     req.Header = headers
 
     client := &http.Client{}
@@ -9879,15 +10018,20 @@ System.out.println(response.toString());
 }
 
 

-
POST /api/boards/{board}/swimlanes

-
Add a swimlane to a board

+
POST /api/boards/{board}/lists/{list}/cards

+
Create a new Card

 

 
Body parameter

 

-
title: string
+
authorId: string
+members: string
+assignees: string
+title: string
+description: string
+swimlaneId: string
 
 

-
Parameters

+
Parameters

 
@@ -9904,7 +10048,14 @@ System.out.println(response.toString());
 
-
+
+
+
+
+
+
+
+
@@ -9914,16 +10065,52 @@ System.out.println(response.toString());
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

 
 
path
 string
 truethe ID of the boardthe board ID of the new card
listpathstringtruethe list ID of the new card
 

 

 bodynone
 

 
» authorIdbodystringtruethe authorId value
» membersbodystringfalsethe member IDs list of the new card
» assigneesbodystringfalsethe array of maximum one ID of assignee of the new card

 » title
 body
 string
 truethe new title of the swimlanethe title of the new card
» descriptionbodystringtruethe description of the new card
» swimlaneIdbodystringtruethe swimlane ID of the new card
 

 
 

 
Detailed descriptions

-
board: the ID of the board

+
board: the board ID of the new card

+
list: the list ID of the new card

 

 
Example responses

 

@@ -9934,7 +10121,7 @@ System.out.println(response.toString());
   "_id": "string"
 }
 

-
Responses

+
Responses

 
@@ -9953,7 +10140,7 @@ System.out.println(response.toString());
 

 
 

 
 

-
Response Schema

+
Response Schema

 
Status Code 200

 
@@ -9979,30 +10166,26 @@ System.out.println(response.toString());
 To perform this operation, you must be authenticated by means of one of the following methods:
 UserSecurity
 
-
get_swimlane

-

+
get_board_list_card

+

 
Code samples

 
# You can also use wget
-curl -X GET /api/boards/{board}/swimlanes/{swimlane} \
-  -H 'Accept: application/json' \
+curl -X GET /api/boards/{board}/lists/{list}/cards/{card} \
   -H 'Authorization: API_KEY'
 
 

-
GET /api/boards/{board}/swimlanes/{swimlane} HTTP/1.1
-
-Accept: application/json
+
GET /api/boards/{board}/lists/{list}/cards/{card} HTTP/1.1
 
-

+
var headers = {
-  'Accept':'application/json',
   'Authorization':'API_KEY'
 
 };
 
 $.ajax({
-  url: '/api/boards/{board}/swimlanes/{swimlane}',
+  url: '/api/boards/{board}/lists/{list}/cards/{card}',
   method: 'get',
 
   headers: headers,
@@ -10015,12 +10198,11 @@ $.ajax({
 
const fetch = require('node-fetch');
 
 const headers = {
-  'Accept':'application/json',
   'Authorization':'API_KEY'
 
 };
 
-fetch('/api/boards/{board}/swimlanes/{swimlane}',
+fetch('/api/boards/{board}/lists/{list}/cards/{card}',
 {
   method: 'GET',
 
@@ -10037,11 +10219,10 @@ fetch('/api/boards/{board}/swimlanes/{swimlane}'require 'json'
 
 headers = {
-  'Accept' => 'application/json',
   'Authorization' => 'API_KEY'
 }
 
-result = RestClient.get '/api/boards/{board}/swimlanes/{swimlane}',
+result = RestClient.get '/api/boards/{board}/lists/{list}/cards/{card}',
   params: {
   }, headers: headers
 
@@ -10050,18 +10231,17 @@ p JSON.parse(result)
 

 
import requests
 headers = {
-  'Accept': 'application/json',
   'Authorization': 'API_KEY'
 }
 
-r = requests.get('/api/boards/{board}/swimlanes/{swimlane}', params={
+r = requests.get('/api/boards/{board}/lists/{list}/cards/{card}', params={
 
 }, headers = headers)
 
 print r.json()
 
 

-
URL obj = new URL("/api/boards/{board}/swimlanes/{swimlane}");
+
URL obj = new URL("/api/boards/{board}/lists/{list}/cards/{card}");
 HttpURLConnection con = (HttpURLConnection) obj.openConnection();
 con.setRequestMethod("GET");
 int responseCode = con.getResponseCode();
@@ -10086,13 +10266,12 @@ System.out.println(response.toString());
 func main() {
 
     headers := map[string][]string{
-        "Accept": []string{"application/json"},
         "Authorization": []string{"API_KEY"},
-
+        
     }
 
     data := bytes.NewBuffer([]byte{jsonReq})
-    req, err := http.NewRequest("GET", "/api/boards/{board}/swimlanes/{swimlane}", data)
+    req, err := http.NewRequest("GET", "/api/boards/{board}/lists/{list}/cards/{card}", data)
     req.Header = headers
 
     client := &http.Client{}
@@ -10101,9 +10280,8 @@ System.out.println(response.toString());
 }
 
 

-
GET /api/boards/{board}/swimlanes/{swimlane}

-
Get a swimlane

-
Parameters

+
GET /api/boards/{board}/lists/{list}/cards/{card}

+
Parameters

 

 
 
 
 

@@ -10120,39 +10298,25 @@ System.out.println(response.toString());
 
-
+
-
+
-
+
+
+
+
+
+
+
+

 
 
path
 string
 truethe ID of the boardthe board value
 

 
swimlanelist
 path
 string
 truethe ID of the swimlanethe list value
cardpathstringtruethe card value
 

 
 

-
Detailed descriptions

-
board: the ID of the board

-
swimlane: the ID of the swimlane

-

-
Example responses

-

-

-
200 Response

-

-
{
-  "title": "string",
-  "archived": true,
-  "boardId": "string",
-  "createdAt": "string",
-  "sort": 0,
-  "color": "white",
-  "updatedAt": "string",
-  "modifiedAt": "string",
-  "type": "string"
-}
-

-
Responses

+
Responses

 
@@ -10167,7 +10331,7 @@ System.out.println(response.toString());
 
-
+

 
 
200
 OK
 200 responseSwimlanesNone
 

 
 

@@ -10175,27 +10339,31 @@ System.out.println(response.toString());
 To perform this operation, you must be authenticated by means of one of the following methods:
 UserSecurity
 
-
delete_board_swimlane

-

+
put_board_list_card

+

 

 
Code samples

 

 
# You can also use wget
-curl -X DELETE /api/boards/{board}/swimlanes/{swimlane} \
+curl -X PUT /api/boards/{board}/lists/{list}/cards/{card} \
+  -H 'Content-Type: multipart/form-data' \
   -H 'Authorization: API_KEY'
 
 

-
DELETE /api/boards/{board}/swimlanes/{swimlane} HTTP/1.1
+
PUT /api/boards/{board}/lists/{list}/cards/{card} HTTP/1.1
 
-

+Content-Type: multipart/form-data
+
+

 
var headers = {
+  'Content-Type':'multipart/form-data',
   'Authorization':'API_KEY'
 
 };
 
 $.ajax({
-  url: '/api/boards/{board}/swimlanes/{swimlane}',
-  method: 'delete',
+  url: '/api/boards/{board}/lists/{list}/cards/{card}',
+  method: 'put',
 
   headers: headers,
   success: function(data) {
@@ -10205,16 +10373,37 @@ $.ajax({
 
 

 
const fetch = require('node-fetch');
-
+const inputBody = '{
+  "title": "string",
+  "listId": "string",
+  "authorId": "string",
+  "parentId": "string",
+  "description": "string",
+  "color": "string",
+  "labelIds": "string",
+  "requestedBy": "string",
+  "assignedBy": "string",
+  "receivedAt": "string",
+  "startAt": "string",
+  "dueAt": "string",
+  "endAt": "string",
+  "spentTime": "string",
+  "isOverTime": "string",
+  "customFields": "string",
+  "members": "string",
+  "assignees": "string",
+  "swimlaneId": "string"
+}';
 const headers = {
+  'Content-Type':'multipart/form-data',
   'Authorization':'API_KEY'
 
 };
 
-fetch('/api/boards/{board}/swimlanes/{swimlane}',
+fetch('/api/boards/{board}/lists/{list}/cards/{card}',
 {
-  method: 'DELETE',
-
+  method: 'PUT',
+  body: inputBody,
   headers: headers
 })
 .then(function(res) {
@@ -10228,10 +10417,11 @@ fetch('/api/boards/{board}/swimlanes/{swimlane}'require 'json'
 
 headers = {
+  'Content-Type' => 'multipart/form-data',
   'Authorization' => 'API_KEY'
 }
 
-result = RestClient.delete '/api/boards/{board}/swimlanes/{swimlane}',
+result = RestClient.put '/api/boards/{board}/lists/{list}/cards/{card}',
   params: {
   }, headers: headers
 
@@ -10240,19 +10430,20 @@ p JSON.parse(result)
 

 
import requests
 headers = {
+  'Content-Type': 'multipart/form-data',
   'Authorization': 'API_KEY'
 }
 
-r = requests.delete('/api/boards/{board}/swimlanes/{swimlane}', params={
+r = requests.put('/api/boards/{board}/lists/{list}/cards/{card}', params={
 
 }, headers = headers)
 
 print r.json()
 
 

-
URL obj = new URL("/api/boards/{board}/swimlanes/{swimlane}");
+
URL obj = new URL("/api/boards/{board}/lists/{list}/cards/{card}");
 HttpURLConnection con = (HttpURLConnection) obj.openConnection();
-con.setRequestMethod("DELETE");
+con.setRequestMethod("PUT");
 int responseCode = con.getResponseCode();
 BufferedReader in = new BufferedReader(
     new InputStreamReader(con.getInputStream()));
@@ -10275,12 +10466,13 @@ System.out.println(response.toString());
 func main() {
 
     headers := map[string][]string{
+        "Content-Type": []string{"multipart/form-data"},
         "Authorization": []string{"API_KEY"},
-
+        
     }
 
     data := bytes.NewBuffer([]byte{jsonReq})
-    req, err := http.NewRequest("DELETE", "/api/boards/{board}/swimlanes/{swimlane}", data)
+    req, err := http.NewRequest("PUT", "/api/boards/{board}/lists/{list}/cards/{card}", data)
     req.Header = headers
 
     client := &http.Client{}
@@ -10289,8 +10481,32 @@ System.out.println(response.toString());
 }
 
 

-
DELETE /api/boards/{board}/swimlanes/{swimlane}

-
Parameters

+
PUT /api/boards/{board}/lists/{list}/cards/{card}

+

+
Body parameter

+

+
title: string
+listId: string
+authorId: string
+parentId: string
+description: string
+color: string
+labelIds: string
+requestedBy: string
+assignedBy: string
+receivedAt: string
+startAt: string
+dueAt: string
+endAt: string
+spentTime: string
+isOverTime: string
+customFields: string
+members: string
+assignees: string
+swimlaneId: string
+
+

+
Parameters

 
@@ -10310,90 +10526,3162 @@ System.out.println(response.toString());
 
-
+
-
+
-
-

 
 
the board value
 

 
swimlanelist
 path
 string
 truethe swimlane valuethe list value
 

-
Responses

-
-
-
-
-
-
+
+
+
+
+
-
-
-
-
-
-
+
+
+
+
+
-
-

 
StatusMeaningDescriptionSchemacardpathstringtruethe card value
 

 
200OK200 responseNonebodybodyobjectfalsenone
 

-
-
Schemas

-
Boards

-

-
{
-  "title": "string",
-  "slug": "string",
-  "archived": true,
-  "createdAt": "string",
-  "modifiedAt": "string",
-  "stars": 0,
-  "labels": [
-    {
-      "_id": "string",
-      "name": "string",
-      "color": "green"
-    }
-  ],
-  "members": [
-    {
-      "userId": "string",
-      "isAdmin": true,
-      "isActive": true,
-      "isNoComments": true,
-      "isCommentOnly": true,
-      "isWorker": true
+
+» title
+body
+string
+true
+the title value
+
+
+» listId
+body
+string
+true
+the listId value
+
+
+» authorId
+body
+string
+true
+the authorId value
+
+
+» parentId
+body
+string
+true
+the parentId value
+
+
+» description
+body
+string
+true
+the description value
+
+
+» color
+body
+string
+true
+the color value
+
+
+» labelIds
+body
+string
+true
+the labelIds value
+
+
+» requestedBy
+body
+string
+true
+the requestedBy value
+
+
+» assignedBy
+body
+string
+true
+the assignedBy value
+
+
+» receivedAt
+body
+string
+true
+the receivedAt value
+
+
+» startAt
+body
+string
+true
+the startAt value
+
+
+» dueAt
+body
+string
+true
+the dueAt value
+
+
+» endAt
+body
+string
+true
+the endAt value
+
+
+» spentTime
+body
+string
+true
+the spentTime value
+
+
+» isOverTime
+body
+string
+true
+the isOverTime value
+
+
+» customFields
+body
+string
+true
+the customFields value
+
+
+» members
+body
+string
+true
+the members value
+
+
+» assignees
+body
+string
+true
+the assignees value
+
+
+» swimlaneId
+body
+string
+true
+the swimlaneId value
+
+
+
+
Responses

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
StatusMeaningDescriptionSchema
200OK200 responseNone

+
+
delete_board_list_card

+

+

+
Code samples

+

+
# You can also use wget
+curl -X DELETE /api/boards/{board}/lists/{list}/cards/{card} \
+  -H 'Authorization: API_KEY'
+
+

+
DELETE /api/boards/{board}/lists/{list}/cards/{card} HTTP/1.1
+
+

+
var headers = {
+  'Authorization':'API_KEY'
+
+};
+
+$.ajax({
+  url: '/api/boards/{board}/lists/{list}/cards/{card}',
+  method: 'delete',
+
+  headers: headers,
+  success: function(data) {
+    console.log(JSON.stringify(data));
+  }
+})
+
+

+
const fetch = require('node-fetch');
+
+const headers = {
+  'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/lists/{list}/cards/{card}',
+{
+  method: 'DELETE',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+

+
require 'rest-client'
+require 'json'
+
+headers = {
+  'Authorization' => 'API_KEY'
+}
+
+result = RestClient.delete '/api/boards/{board}/lists/{list}/cards/{card}',
+  params: {
+  }, headers: headers
+
+p JSON.parse(result)
+
+

+
import requests
+headers = {
+  'Authorization': 'API_KEY'
+}
+
+r = requests.delete('/api/boards/{board}/lists/{list}/cards/{card}', params={
+
+}, headers = headers)
+
+print r.json()
+
+

+
URL obj = new URL("/api/boards/{board}/lists/{list}/cards/{card}");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("DELETE");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+    new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+    response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+

+
package main
+
+import (
+       "bytes"
+       "net/http"
+)
+
+func main() {
+
+    headers := map[string][]string{
+        "Authorization": []string{"API_KEY"},
+        
     }
-  ],
-  "permission": "public",
-  "color": "belize",
-  "description": "string",
-  "subtasksDefaultBoardId": "string",
-  "subtasksDefaultListId": "string",
-  "dateSettingsDefaultBoardId": "string",
-  "dateSettingsDefaultListId": "string",
-  "allowsSubtasks": true,
-  "allowsAttachments": true,
-  "allowsChecklists": true,
-  "allowsComments": true,
-  "allowsDescriptionTitle": true,
-  "allowsDescriptionText": true,
-  "allowsActivities": true,
-  "allowsLabels": true,
-  "allowsAssignee": true,
-  "allowsMembers": true,
-  "allowsRequestedBy": true,
-  "allowsAssignedBy": true,
-  "allowsReceivedDate": true,
-  "allowsStartDate": true,
-  "allowsEndDate": true,
-  "allowsDueDate": true,
-  "presentParentTask": "prefix-with-full-path",
-  "startAt": "string",
-  "dueAt": "string",
+
+    data := bytes.NewBuffer([]byte{jsonReq})
+    req, err := http.NewRequest("DELETE", "/api/boards/{board}/lists/{list}/cards/{card}", data)
+    req.Header = headers
+
+    client := &http.Client{}
+    resp, err := client.Do(req)
+    // ...
+}
+
+

+
DELETE /api/boards/{board}/lists/{list}/cards/{card}

+
Parameters

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameInTypeRequiredDescription
boardpathstringtruethe board value
listpathstringtruethe list value
cardpathstringtruethe card value

+
Responses

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
StatusMeaningDescriptionSchema
200OK200 responseNone

+
+
get_board_swimlane_cards

+

+

+
Code samples

+

+
# You can also use wget
+curl -X GET /api/boards/{board}/swimlanes/{swimlane}/cards \
+  -H 'Authorization: API_KEY'
+
+

+
GET /api/boards/{board}/swimlanes/{swimlane}/cards HTTP/1.1
+
+

+
var headers = {
+  'Authorization':'API_KEY'
+
+};
+
+$.ajax({
+  url: '/api/boards/{board}/swimlanes/{swimlane}/cards',
+  method: 'get',
+
+  headers: headers,
+  success: function(data) {
+    console.log(JSON.stringify(data));
+  }
+})
+
+

+
const fetch = require('node-fetch');
+
+const headers = {
+  'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/swimlanes/{swimlane}/cards',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+

+
require 'rest-client'
+require 'json'
+
+headers = {
+  'Authorization' => 'API_KEY'
+}
+
+result = RestClient.get '/api/boards/{board}/swimlanes/{swimlane}/cards',
+  params: {
+  }, headers: headers
+
+p JSON.parse(result)
+
+

+
import requests
+headers = {
+  'Authorization': 'API_KEY'
+}
+
+r = requests.get('/api/boards/{board}/swimlanes/{swimlane}/cards', params={
+
+}, headers = headers)
+
+print r.json()
+
+

+
URL obj = new URL("/api/boards/{board}/swimlanes/{swimlane}/cards");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+    new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+    response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+

+
package main
+
+import (
+       "bytes"
+       "net/http"
+)
+
+func main() {
+
+    headers := map[string][]string{
+        "Authorization": []string{"API_KEY"},
+        
+    }
+
+    data := bytes.NewBuffer([]byte{jsonReq})
+    req, err := http.NewRequest("GET", "/api/boards/{board}/swimlanes/{swimlane}/cards", data)
+    req.Header = headers
+
+    client := &http.Client{}
+    resp, err := client.Do(req)
+    // ...
+}
+
+

+
GET /api/boards/{board}/swimlanes/{swimlane}/cards

+
Parameters

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameInTypeRequiredDescription
boardpathstringtruethe board value
swimlanepathstringtruethe swimlane value

+
Responses

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
StatusMeaningDescriptionSchema
200OK200 responseNone

+
+
Users

+
add_board_member

+

+

+
Code samples

+

+
# You can also use wget
+curl -X POST /api/boards/{board}/members/{user}/add \
+  -H 'Content-Type: multipart/form-data' \
+  -H 'Accept: application/json' \
+  -H 'Authorization: API_KEY'
+
+

+
POST /api/boards/{board}/members/{user}/add HTTP/1.1
+
+Content-Type: multipart/form-data
+Accept: application/json
+
+

+
var headers = {
+  'Content-Type':'multipart/form-data',
+  'Accept':'application/json',
+  'Authorization':'API_KEY'
+
+};
+
+$.ajax({
+  url: '/api/boards/{board}/members/{user}/add',
+  method: 'post',
+
+  headers: headers,
+  success: function(data) {
+    console.log(JSON.stringify(data));
+  }
+})
+
+

+
const fetch = require('node-fetch');
+const inputBody = '{
+  "action": "string",
+  "isAdmin": true,
+  "isNoComments": true,
+  "isCommentOnly": true
+}';
+const headers = {
+  'Content-Type':'multipart/form-data',
+  'Accept':'application/json',
+  'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/members/{user}/add',
+{
+  method: 'POST',
+  body: inputBody,
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+

+
require 'rest-client'
+require 'json'
+
+headers = {
+  'Content-Type' => 'multipart/form-data',
+  'Accept' => 'application/json',
+  'Authorization' => 'API_KEY'
+}
+
+result = RestClient.post '/api/boards/{board}/members/{user}/add',
+  params: {
+  }, headers: headers
+
+p JSON.parse(result)
+
+

+
import requests
+headers = {
+  'Content-Type': 'multipart/form-data',
+  'Accept': 'application/json',
+  'Authorization': 'API_KEY'
+}
+
+r = requests.post('/api/boards/{board}/members/{user}/add', params={
+
+}, headers = headers)
+
+print r.json()
+
+

+
URL obj = new URL("/api/boards/{board}/members/{user}/add");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("POST");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+    new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+    response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+

+
package main
+
+import (
+       "bytes"
+       "net/http"
+)
+
+func main() {
+
+    headers := map[string][]string{
+        "Content-Type": []string{"multipart/form-data"},
+        "Accept": []string{"application/json"},
+        "Authorization": []string{"API_KEY"},
+        
+    }
+
+    data := bytes.NewBuffer([]byte{jsonReq})
+    req, err := http.NewRequest("POST", "/api/boards/{board}/members/{user}/add", data)
+    req.Header = headers
+
+    client := &http.Client{}
+    resp, err := client.Do(req)
+    // ...
+}
+
+

+
POST /api/boards/{board}/members/{user}/add

+
Add New Board Member with Role

+
Only the admin user (the first user) can call the REST API.

+
Note: see Boards.set_board_member_permission
+to later change the permissions.

+

+
Body parameter

+

+
action: string
+isAdmin: true
+isNoComments: true
+isCommentOnly: true
+
+

+
Parameters

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameInTypeRequiredDescription
boardpathstringtruethe board ID
userpathstringtruethe user ID
bodybodyobjectfalsenone
» actionbodystringtruethe action value
» isAdminbodybooleantrueis the user an admin of the board
» isNoCommentsbodybooleantruedisable comments
» isCommentOnlybodybooleantrueonly enable comments

+
Detailed descriptions

+
board: the board ID

+
user: the user ID

+

+
Example responses

+

+

+
200 Response

+

+
{
+  "_id": "string",
+  "title": "string"
+}
+

+
Responses

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
StatusMeaningDescriptionSchema
200OK200 responseInline

+
Response Schema

+
Status Code 200

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameTypeRequiredRestrictionsDescription
» _idstringfalsenonenone
» titlestringfalsenonenone

+
+
post_board_user_remove

+

+

+
Code samples

+

+
# You can also use wget
+curl -X POST /api/boards/{board}/members/{user}/remove \
+  -H 'Content-Type: multipart/form-data' \
+  -H 'Authorization: API_KEY'
+
+

+
POST /api/boards/{board}/members/{user}/remove HTTP/1.1
+
+Content-Type: multipart/form-data
+
+

+
var headers = {
+  'Content-Type':'multipart/form-data',
+  'Authorization':'API_KEY'
+
+};
+
+$.ajax({
+  url: '/api/boards/{board}/members/{user}/remove',
+  method: 'post',
+
+  headers: headers,
+  success: function(data) {
+    console.log(JSON.stringify(data));
+  }
+})
+
+

+
const fetch = require('node-fetch');
+const inputBody = '{
+  "action": "string"
+}';
+const headers = {
+  'Content-Type':'multipart/form-data',
+  'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/members/{user}/remove',
+{
+  method: 'POST',
+  body: inputBody,
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+

+
require 'rest-client'
+require 'json'
+
+headers = {
+  'Content-Type' => 'multipart/form-data',
+  'Authorization' => 'API_KEY'
+}
+
+result = RestClient.post '/api/boards/{board}/members/{user}/remove',
+  params: {
+  }, headers: headers
+
+p JSON.parse(result)
+
+

+
import requests
+headers = {
+  'Content-Type': 'multipart/form-data',
+  'Authorization': 'API_KEY'
+}
+
+r = requests.post('/api/boards/{board}/members/{user}/remove', params={
+
+}, headers = headers)
+
+print r.json()
+
+

+
URL obj = new URL("/api/boards/{board}/members/{user}/remove");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("POST");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+    new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+    response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+

+
package main
+
+import (
+       "bytes"
+       "net/http"
+)
+
+func main() {
+
+    headers := map[string][]string{
+        "Content-Type": []string{"multipart/form-data"},
+        "Authorization": []string{"API_KEY"},
+        
+    }
+
+    data := bytes.NewBuffer([]byte{jsonReq})
+    req, err := http.NewRequest("POST", "/api/boards/{board}/members/{user}/remove", data)
+    req.Header = headers
+
+    client := &http.Client{}
+    resp, err := client.Do(req)
+    // ...
+}
+
+

+
POST /api/boards/{board}/members/{user}/remove

+

+
Body parameter

+

+
action: string
+
+

+
Parameters

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameInTypeRequiredDescription
boardpathstringtruethe board value
userpathstringtruethe user value
bodybodyobjectfalsenone
» actionbodystringtruethe action value

+
Responses

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
StatusMeaningDescriptionSchema
200OK200 responseNone

+
+
get_current_user

+

+

+
Code samples

+

+
# You can also use wget
+curl -X GET /api/user \
+  -H 'Accept: application/json' \
+  -H 'Authorization: API_KEY'
+
+

+
GET /api/user HTTP/1.1
+
+Accept: application/json
+
+

+
var headers = {
+  'Accept':'application/json',
+  'Authorization':'API_KEY'
+
+};
+
+$.ajax({
+  url: '/api/user',
+  method: 'get',
+
+  headers: headers,
+  success: function(data) {
+    console.log(JSON.stringify(data));
+  }
+})
+
+

+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'Authorization':'API_KEY'
+
+};
+
+fetch('/api/user',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+

+
require 'rest-client'
+require 'json'
+
+headers = {
+  'Accept' => 'application/json',
+  'Authorization' => 'API_KEY'
+}
+
+result = RestClient.get '/api/user',
+  params: {
+  }, headers: headers
+
+p JSON.parse(result)
+
+

+
import requests
+headers = {
+  'Accept': 'application/json',
+  'Authorization': 'API_KEY'
+}
+
+r = requests.get('/api/user', params={
+
+}, headers = headers)
+
+print r.json()
+
+

+
URL obj = new URL("/api/user");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+    new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+    response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+

+
package main
+
+import (
+       "bytes"
+       "net/http"
+)
+
+func main() {
+
+    headers := map[string][]string{
+        "Accept": []string{"application/json"},
+        "Authorization": []string{"API_KEY"},
+        
+    }
+
+    data := bytes.NewBuffer([]byte{jsonReq})
+    req, err := http.NewRequest("GET", "/api/user", data)
+    req.Header = headers
+
+    client := &http.Client{}
+    resp, err := client.Do(req)
+    // ...
+}
+
+

+
GET /api/user

+
returns the current user

+

+
Example responses

+

+

+
200 Response

+

+
{
+  "username": "string",
+  "emails": [
+    {
+      "address": "string",
+      "verified": true
+    }
+  ],
+  "createdAt": "string",
+  "modifiedAt": "string",
+  "profile": {
+    "avatarUrl": "string",
+    "emailBuffer": [
+      "string"
+    ],
+    "fullname": "string",
+    "showDesktopDragHandles": true,
+    "hiddenSystemMessages": true,
+    "hiddenMinicardLabelText": true,
+    "initials": "string",
+    "invitedBoards": [
+      "string"
+    ],
+    "language": "string",
+    "notifications": [],
+    "activity": "string",
+    "read": "string",
+    "showCardsCountAt": 0,
+    "startDayOfWeek": 0,
+    "starredBoards": [
+      "string"
+    ],
+    "icode": "string",
+    "boardView": "board-view-lists",
+    "listSortBy": "-modifiedat",
+    "templatesBoardId": "string",
+    "cardTemplatesSwimlaneId": "string",
+    "listTemplatesSwimlaneId": "string",
+    "boardTemplatesSwimlaneId": "string"
+  },
+  "services": {},
+  "heartbeat": "string",
+  "isAdmin": true,
+  "createdThroughApi": true,
+  "loginDisabled": true,
+  "authenticationMethod": "string"
+}
+

+
Responses

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
StatusMeaningDescriptionSchema
200OK200 responseUsers

+
+
get_all_users

+

+

+
Code samples

+

+
# You can also use wget
+curl -X GET /api/users \
+  -H 'Accept: application/json' \
+  -H 'Authorization: API_KEY'
+
+

+
GET /api/users HTTP/1.1
+
+Accept: application/json
+
+

+
var headers = {
+  'Accept':'application/json',
+  'Authorization':'API_KEY'
+
+};
+
+$.ajax({
+  url: '/api/users',
+  method: 'get',
+
+  headers: headers,
+  success: function(data) {
+    console.log(JSON.stringify(data));
+  }
+})
+
+

+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'Authorization':'API_KEY'
+
+};
+
+fetch('/api/users',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+

+
require 'rest-client'
+require 'json'
+
+headers = {
+  'Accept' => 'application/json',
+  'Authorization' => 'API_KEY'
+}
+
+result = RestClient.get '/api/users',
+  params: {
+  }, headers: headers
+
+p JSON.parse(result)
+
+

+
import requests
+headers = {
+  'Accept': 'application/json',
+  'Authorization': 'API_KEY'
+}
+
+r = requests.get('/api/users', params={
+
+}, headers = headers)
+
+print r.json()
+
+

+
URL obj = new URL("/api/users");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+    new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+    response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+

+
package main
+
+import (
+       "bytes"
+       "net/http"
+)
+
+func main() {
+
+    headers := map[string][]string{
+        "Accept": []string{"application/json"},
+        "Authorization": []string{"API_KEY"},
+        
+    }
+
+    data := bytes.NewBuffer([]byte{jsonReq})
+    req, err := http.NewRequest("GET", "/api/users", data)
+    req.Header = headers
+
+    client := &http.Client{}
+    resp, err := client.Do(req)
+    // ...
+}
+
+

+
GET /api/users

+
return all the users

+
Only the admin user (the first user) can call the REST API.

+

+
Example responses

+

+

+
200 Response

+

+
[
+  {
+    "_id": "string",
+    "username": "string"
+  }
+]
+

+
Responses

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
StatusMeaningDescriptionSchema
200OK200 responseInline

+
Response Schema

+
Status Code 200

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameTypeRequiredRestrictionsDescription
» _idstringfalsenonenone
» usernamestringfalsenonenone

+
+
new_user

+

+

+
Code samples

+

+
# You can also use wget
+curl -X POST /api/users \
+  -H 'Content-Type: multipart/form-data' \
+  -H 'Accept: application/json' \
+  -H 'Authorization: API_KEY'
+
+

+
POST /api/users HTTP/1.1
+
+Content-Type: multipart/form-data
+Accept: application/json
+
+

+
var headers = {
+  'Content-Type':'multipart/form-data',
+  'Accept':'application/json',
+  'Authorization':'API_KEY'
+
+};
+
+$.ajax({
+  url: '/api/users',
+  method: 'post',
+
+  headers: headers,
+  success: function(data) {
+    console.log(JSON.stringify(data));
+  }
+})
+
+

+
const fetch = require('node-fetch');
+const inputBody = '{
+  "username": "string",
+  "email": "string",
+  "password": "string"
+}';
+const headers = {
+  'Content-Type':'multipart/form-data',
+  'Accept':'application/json',
+  'Authorization':'API_KEY'
+
+};
+
+fetch('/api/users',
+{
+  method: 'POST',
+  body: inputBody,
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+

+
require 'rest-client'
+require 'json'
+
+headers = {
+  'Content-Type' => 'multipart/form-data',
+  'Accept' => 'application/json',
+  'Authorization' => 'API_KEY'
+}
+
+result = RestClient.post '/api/users',
+  params: {
+  }, headers: headers
+
+p JSON.parse(result)
+
+

+
import requests
+headers = {
+  'Content-Type': 'multipart/form-data',
+  'Accept': 'application/json',
+  'Authorization': 'API_KEY'
+}
+
+r = requests.post('/api/users', params={
+
+}, headers = headers)
+
+print r.json()
+
+

+
URL obj = new URL("/api/users");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("POST");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+    new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+    response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+

+
package main
+
+import (
+       "bytes"
+       "net/http"
+)
+
+func main() {
+
+    headers := map[string][]string{
+        "Content-Type": []string{"multipart/form-data"},
+        "Accept": []string{"application/json"},
+        "Authorization": []string{"API_KEY"},
+        
+    }
+
+    data := bytes.NewBuffer([]byte{jsonReq})
+    req, err := http.NewRequest("POST", "/api/users", data)
+    req.Header = headers
+
+    client := &http.Client{}
+    resp, err := client.Do(req)
+    // ...
+}
+
+

+
POST /api/users

+
Create a new user

+
Only the admin user (the first user) can call the REST API.

+

+
Body parameter

+

+
username: string
+email: string
+password: string
+
+

+
Parameters

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameInTypeRequiredDescription
bodybodyobjectfalsenone
» usernamebodystringtruethe new username
» emailbodystringtruethe email of the new user
» passwordbodystringtruethe password of the new user

+

+
Example responses

+

+

+
200 Response

+

+
{
+  "_id": "string"
+}
+

+
Responses

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
StatusMeaningDescriptionSchema
200OK200 responseInline

+
Response Schema

+
Status Code 200

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameTypeRequiredRestrictionsDescription
» _idstringfalsenonenone

+
+
get_user

+

+

+
Code samples

+

+
# You can also use wget
+curl -X GET /api/users/{user} \
+  -H 'Accept: application/json' \
+  -H 'Authorization: API_KEY'
+
+

+
GET /api/users/{user} HTTP/1.1
+
+Accept: application/json
+
+

+
var headers = {
+  'Accept':'application/json',
+  'Authorization':'API_KEY'
+
+};
+
+$.ajax({
+  url: '/api/users/{user}',
+  method: 'get',
+
+  headers: headers,
+  success: function(data) {
+    console.log(JSON.stringify(data));
+  }
+})
+
+

+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'Authorization':'API_KEY'
+
+};
+
+fetch('/api/users/{user}',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+

+
require 'rest-client'
+require 'json'
+
+headers = {
+  'Accept' => 'application/json',
+  'Authorization' => 'API_KEY'
+}
+
+result = RestClient.get '/api/users/{user}',
+  params: {
+  }, headers: headers
+
+p JSON.parse(result)
+
+

+
import requests
+headers = {
+  'Accept': 'application/json',
+  'Authorization': 'API_KEY'
+}
+
+r = requests.get('/api/users/{user}', params={
+
+}, headers = headers)
+
+print r.json()
+
+

+
URL obj = new URL("/api/users/{user}");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+    new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+    response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+

+
package main
+
+import (
+       "bytes"
+       "net/http"
+)
+
+func main() {
+
+    headers := map[string][]string{
+        "Accept": []string{"application/json"},
+        "Authorization": []string{"API_KEY"},
+        
+    }
+
+    data := bytes.NewBuffer([]byte{jsonReq})
+    req, err := http.NewRequest("GET", "/api/users/{user}", data)
+    req.Header = headers
+
+    client := &http.Client{}
+    resp, err := client.Do(req)
+    // ...
+}
+
+

+
GET /api/users/{user}

+
get a given user

+
Only the admin user (the first user) can call the REST API.

+
Parameters

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameInTypeRequiredDescription
userpathstringtruethe user ID

+
Detailed descriptions

+
user: the user ID

+

+
Example responses

+

+

+
200 Response

+

+
{
+  "username": "string",
+  "emails": [
+    {
+      "address": "string",
+      "verified": true
+    }
+  ],
+  "createdAt": "string",
+  "modifiedAt": "string",
+  "profile": {
+    "avatarUrl": "string",
+    "emailBuffer": [
+      "string"
+    ],
+    "fullname": "string",
+    "showDesktopDragHandles": true,
+    "hiddenSystemMessages": true,
+    "hiddenMinicardLabelText": true,
+    "initials": "string",
+    "invitedBoards": [
+      "string"
+    ],
+    "language": "string",
+    "notifications": [],
+    "activity": "string",
+    "read": "string",
+    "showCardsCountAt": 0,
+    "startDayOfWeek": 0,
+    "starredBoards": [
+      "string"
+    ],
+    "icode": "string",
+    "boardView": "board-view-lists",
+    "listSortBy": "-modifiedat",
+    "templatesBoardId": "string",
+    "cardTemplatesSwimlaneId": "string",
+    "listTemplatesSwimlaneId": "string",
+    "boardTemplatesSwimlaneId": "string"
+  },
+  "services": {},
+  "heartbeat": "string",
+  "isAdmin": true,
+  "createdThroughApi": true,
+  "loginDisabled": true,
+  "authenticationMethod": "string"
+}
+

+
Responses

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
StatusMeaningDescriptionSchema
200OK200 responseUsers

+
+
edit_user

+

+

+
Code samples

+

+
# You can also use wget
+curl -X PUT /api/users/{user} \
+  -H 'Content-Type: multipart/form-data' \
+  -H 'Accept: application/json' \
+  -H 'Authorization: API_KEY'
+
+

+
PUT /api/users/{user} HTTP/1.1
+
+Content-Type: multipart/form-data
+Accept: application/json
+
+

+
var headers = {
+  'Content-Type':'multipart/form-data',
+  'Accept':'application/json',
+  'Authorization':'API_KEY'
+
+};
+
+$.ajax({
+  url: '/api/users/{user}',
+  method: 'put',
+
+  headers: headers,
+  success: function(data) {
+    console.log(JSON.stringify(data));
+  }
+})
+
+

+
const fetch = require('node-fetch');
+const inputBody = '{
+  "action": "string"
+}';
+const headers = {
+  'Content-Type':'multipart/form-data',
+  'Accept':'application/json',
+  'Authorization':'API_KEY'
+
+};
+
+fetch('/api/users/{user}',
+{
+  method: 'PUT',
+  body: inputBody,
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+

+
require 'rest-client'
+require 'json'
+
+headers = {
+  'Content-Type' => 'multipart/form-data',
+  'Accept' => 'application/json',
+  'Authorization' => 'API_KEY'
+}
+
+result = RestClient.put '/api/users/{user}',
+  params: {
+  }, headers: headers
+
+p JSON.parse(result)
+
+

+
import requests
+headers = {
+  'Content-Type': 'multipart/form-data',
+  'Accept': 'application/json',
+  'Authorization': 'API_KEY'
+}
+
+r = requests.put('/api/users/{user}', params={
+
+}, headers = headers)
+
+print r.json()
+
+

+
URL obj = new URL("/api/users/{user}");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("PUT");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+    new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+    response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+

+
package main
+
+import (
+       "bytes"
+       "net/http"
+)
+
+func main() {
+
+    headers := map[string][]string{
+        "Content-Type": []string{"multipart/form-data"},
+        "Accept": []string{"application/json"},
+        "Authorization": []string{"API_KEY"},
+        
+    }
+
+    data := bytes.NewBuffer([]byte{jsonReq})
+    req, err := http.NewRequest("PUT", "/api/users/{user}", data)
+    req.Header = headers
+
+    client := &http.Client{}
+    resp, err := client.Do(req)
+    // ...
+}
+
+

+
PUT /api/users/{user}

+
edit a given user

+
Only the admin user (the first user) can call the REST API.

+
Possible values for action:

+
    
+
  • takeOwnership: The admin takes the ownership of ALL boards of the user (archived and not archived) where the user is admin on.
    • 
+
  • disableLogin: Disable a user (the user is not allowed to login and his login tokens are purged)
    • 
+
  • enableLogin: Enable a user
    • 
+

+

+
Body parameter

+

+
action: string
+
+

+
Parameters

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameInTypeRequiredDescription
userpathstringtruethe user ID
bodybodyobjectfalsenone
» actionbodystringtruethe action

+
Detailed descriptions

+
user: the user ID

+

+
Example responses

+

+

+
200 Response

+

+
{
+  "_id": "string",
+  "title": "string"
+}
+

+
Responses

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
StatusMeaningDescriptionSchema
200OK200 responseInline

+
Response Schema

+
Status Code 200

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameTypeRequiredRestrictionsDescription
» _idstringfalsenonenone
» titlestringfalsenonenone

+
+
delete_user

+

+

+
Code samples

+

+
# You can also use wget
+curl -X DELETE /api/users/{user} \
+  -H 'Accept: application/json' \
+  -H 'Authorization: API_KEY'
+
+

+
DELETE /api/users/{user} HTTP/1.1
+
+Accept: application/json
+
+

+
var headers = {
+  'Accept':'application/json',
+  'Authorization':'API_KEY'
+
+};
+
+$.ajax({
+  url: '/api/users/{user}',
+  method: 'delete',
+
+  headers: headers,
+  success: function(data) {
+    console.log(JSON.stringify(data));
+  }
+})
+
+

+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'Authorization':'API_KEY'
+
+};
+
+fetch('/api/users/{user}',
+{
+  method: 'DELETE',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+

+
require 'rest-client'
+require 'json'
+
+headers = {
+  'Accept' => 'application/json',
+  'Authorization' => 'API_KEY'
+}
+
+result = RestClient.delete '/api/users/{user}',
+  params: {
+  }, headers: headers
+
+p JSON.parse(result)
+
+

+
import requests
+headers = {
+  'Accept': 'application/json',
+  'Authorization': 'API_KEY'
+}
+
+r = requests.delete('/api/users/{user}', params={
+
+}, headers = headers)
+
+print r.json()
+
+

+
URL obj = new URL("/api/users/{user}");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("DELETE");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+    new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+    response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+

+
package main
+
+import (
+       "bytes"
+       "net/http"
+)
+
+func main() {
+
+    headers := map[string][]string{
+        "Accept": []string{"application/json"},
+        "Authorization": []string{"API_KEY"},
+        
+    }
+
+    data := bytes.NewBuffer([]byte{jsonReq})
+    req, err := http.NewRequest("DELETE", "/api/users/{user}", data)
+    req.Header = headers
+
+    client := &http.Client{}
+    resp, err := client.Do(req)
+    // ...
+}
+
+

+
DELETE /api/users/{user}

+
Delete a user

+
Only the admin user (the first user) can call the REST API.

+
Parameters

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameInTypeRequiredDescription
userpathstringtruethe ID of the user to delete

+
Detailed descriptions

+
user: the ID of the user to delete

+

+
Example responses

+

+

+
200 Response

+

+
{
+  "_id": "string"
+}
+

+
Responses

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
StatusMeaningDescriptionSchema
200OK200 responseInline

+
Response Schema

+
Status Code 200

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameTypeRequiredRestrictionsDescription
» _idstringfalsenonenone

+
+
Swimlanes

+
get_all_swimlanes

+

+

+
Code samples

+

+
# You can also use wget
+curl -X GET /api/boards/{board}/swimlanes \
+  -H 'Accept: application/json' \
+  -H 'Authorization: API_KEY'
+
+

+
GET /api/boards/{board}/swimlanes HTTP/1.1
+
+Accept: application/json
+
+

+
var headers = {
+  'Accept':'application/json',
+  'Authorization':'API_KEY'
+
+};
+
+$.ajax({
+  url: '/api/boards/{board}/swimlanes',
+  method: 'get',
+
+  headers: headers,
+  success: function(data) {
+    console.log(JSON.stringify(data));
+  }
+})
+
+

+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/swimlanes',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+

+
require 'rest-client'
+require 'json'
+
+headers = {
+  'Accept' => 'application/json',
+  'Authorization' => 'API_KEY'
+}
+
+result = RestClient.get '/api/boards/{board}/swimlanes',
+  params: {
+  }, headers: headers
+
+p JSON.parse(result)
+
+

+
import requests
+headers = {
+  'Accept': 'application/json',
+  'Authorization': 'API_KEY'
+}
+
+r = requests.get('/api/boards/{board}/swimlanes', params={
+
+}, headers = headers)
+
+print r.json()
+
+

+
URL obj = new URL("/api/boards/{board}/swimlanes");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+    new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+    response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+

+
package main
+
+import (
+       "bytes"
+       "net/http"
+)
+
+func main() {
+
+    headers := map[string][]string{
+        "Accept": []string{"application/json"},
+        "Authorization": []string{"API_KEY"},
+        
+    }
+
+    data := bytes.NewBuffer([]byte{jsonReq})
+    req, err := http.NewRequest("GET", "/api/boards/{board}/swimlanes", data)
+    req.Header = headers
+
+    client := &http.Client{}
+    resp, err := client.Do(req)
+    // ...
+}
+
+

+
GET /api/boards/{board}/swimlanes

+
Get the list of swimlanes attached to a board

+
Parameters

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameInTypeRequiredDescription
boardpathstringtruethe ID of the board

+
Detailed descriptions

+
board: the ID of the board

+

+
Example responses

+

+

+
200 Response

+

+
[
+  {
+    "_id": "string",
+    "title": "string"
+  }
+]
+

+
Responses

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
StatusMeaningDescriptionSchema
200OK200 responseInline

+
Response Schema

+
Status Code 200

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameTypeRequiredRestrictionsDescription
» _idstringfalsenonenone
» titlestringfalsenonenone

+
+
new_swimlane

+

+

+
Code samples

+

+
# You can also use wget
+curl -X POST /api/boards/{board}/swimlanes \
+  -H 'Content-Type: multipart/form-data' \
+  -H 'Accept: application/json' \
+  -H 'Authorization: API_KEY'
+
+

+
POST /api/boards/{board}/swimlanes HTTP/1.1
+
+Content-Type: multipart/form-data
+Accept: application/json
+
+

+
var headers = {
+  'Content-Type':'multipart/form-data',
+  'Accept':'application/json',
+  'Authorization':'API_KEY'
+
+};
+
+$.ajax({
+  url: '/api/boards/{board}/swimlanes',
+  method: 'post',
+
+  headers: headers,
+  success: function(data) {
+    console.log(JSON.stringify(data));
+  }
+})
+
+

+
const fetch = require('node-fetch');
+const inputBody = '{
+  "title": "string"
+}';
+const headers = {
+  'Content-Type':'multipart/form-data',
+  'Accept':'application/json',
+  'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/swimlanes',
+{
+  method: 'POST',
+  body: inputBody,
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+

+
require 'rest-client'
+require 'json'
+
+headers = {
+  'Content-Type' => 'multipart/form-data',
+  'Accept' => 'application/json',
+  'Authorization' => 'API_KEY'
+}
+
+result = RestClient.post '/api/boards/{board}/swimlanes',
+  params: {
+  }, headers: headers
+
+p JSON.parse(result)
+
+

+
import requests
+headers = {
+  'Content-Type': 'multipart/form-data',
+  'Accept': 'application/json',
+  'Authorization': 'API_KEY'
+}
+
+r = requests.post('/api/boards/{board}/swimlanes', params={
+
+}, headers = headers)
+
+print r.json()
+
+

+
URL obj = new URL("/api/boards/{board}/swimlanes");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("POST");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+    new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+    response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+

+
package main
+
+import (
+       "bytes"
+       "net/http"
+)
+
+func main() {
+
+    headers := map[string][]string{
+        "Content-Type": []string{"multipart/form-data"},
+        "Accept": []string{"application/json"},
+        "Authorization": []string{"API_KEY"},
+        
+    }
+
+    data := bytes.NewBuffer([]byte{jsonReq})
+    req, err := http.NewRequest("POST", "/api/boards/{board}/swimlanes", data)
+    req.Header = headers
+
+    client := &http.Client{}
+    resp, err := client.Do(req)
+    // ...
+}
+
+

+
POST /api/boards/{board}/swimlanes

+
Add a swimlane to a board

+

+
Body parameter

+

+
title: string
+
+

+
Parameters

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameInTypeRequiredDescription
boardpathstringtruethe ID of the board
bodybodyobjectfalsenone
» titlebodystringtruethe new title of the swimlane

+
Detailed descriptions

+
board: the ID of the board

+

+
Example responses

+

+

+
200 Response

+

+
{
+  "_id": "string"
+}
+

+
Responses

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
StatusMeaningDescriptionSchema
200OK200 responseInline

+
Response Schema

+
Status Code 200

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameTypeRequiredRestrictionsDescription
» _idstringfalsenonenone

+
+
get_swimlane

+

+

+
Code samples

+

+
# You can also use wget
+curl -X GET /api/boards/{board}/swimlanes/{swimlane} \
+  -H 'Accept: application/json' \
+  -H 'Authorization: API_KEY'
+
+

+
GET /api/boards/{board}/swimlanes/{swimlane} HTTP/1.1
+
+Accept: application/json
+
+

+
var headers = {
+  'Accept':'application/json',
+  'Authorization':'API_KEY'
+
+};
+
+$.ajax({
+  url: '/api/boards/{board}/swimlanes/{swimlane}',
+  method: 'get',
+
+  headers: headers,
+  success: function(data) {
+    console.log(JSON.stringify(data));
+  }
+})
+
+

+
const fetch = require('node-fetch');
+
+const headers = {
+  'Accept':'application/json',
+  'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/swimlanes/{swimlane}',
+{
+  method: 'GET',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+

+
require 'rest-client'
+require 'json'
+
+headers = {
+  'Accept' => 'application/json',
+  'Authorization' => 'API_KEY'
+}
+
+result = RestClient.get '/api/boards/{board}/swimlanes/{swimlane}',
+  params: {
+  }, headers: headers
+
+p JSON.parse(result)
+
+

+
import requests
+headers = {
+  'Accept': 'application/json',
+  'Authorization': 'API_KEY'
+}
+
+r = requests.get('/api/boards/{board}/swimlanes/{swimlane}', params={
+
+}, headers = headers)
+
+print r.json()
+
+

+
URL obj = new URL("/api/boards/{board}/swimlanes/{swimlane}");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("GET");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+    new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+    response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+

+
package main
+
+import (
+       "bytes"
+       "net/http"
+)
+
+func main() {
+
+    headers := map[string][]string{
+        "Accept": []string{"application/json"},
+        "Authorization": []string{"API_KEY"},
+        
+    }
+
+    data := bytes.NewBuffer([]byte{jsonReq})
+    req, err := http.NewRequest("GET", "/api/boards/{board}/swimlanes/{swimlane}", data)
+    req.Header = headers
+
+    client := &http.Client{}
+    resp, err := client.Do(req)
+    // ...
+}
+
+

+
GET /api/boards/{board}/swimlanes/{swimlane}

+
Get a swimlane

+
Parameters

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameInTypeRequiredDescription
boardpathstringtruethe ID of the board
swimlanepathstringtruethe ID of the swimlane

+
Detailed descriptions

+
board: the ID of the board

+
swimlane: the ID of the swimlane

+

+
Example responses

+

+

+
200 Response

+

+
{
+  "title": "string",
+  "archived": true,
+  "boardId": "string",
+  "createdAt": "string",
+  "sort": 0,
+  "color": "white",
+  "updatedAt": "string",
+  "modifiedAt": "string",
+  "type": "string"
+}
+

+
Responses

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
StatusMeaningDescriptionSchema
200OK200 responseSwimlanes

+
+
delete_board_swimlane

+

+

+
Code samples

+

+
# You can also use wget
+curl -X DELETE /api/boards/{board}/swimlanes/{swimlane} \
+  -H 'Authorization: API_KEY'
+
+

+
DELETE /api/boards/{board}/swimlanes/{swimlane} HTTP/1.1
+
+

+
var headers = {
+  'Authorization':'API_KEY'
+
+};
+
+$.ajax({
+  url: '/api/boards/{board}/swimlanes/{swimlane}',
+  method: 'delete',
+
+  headers: headers,
+  success: function(data) {
+    console.log(JSON.stringify(data));
+  }
+})
+
+

+
const fetch = require('node-fetch');
+
+const headers = {
+  'Authorization':'API_KEY'
+
+};
+
+fetch('/api/boards/{board}/swimlanes/{swimlane}',
+{
+  method: 'DELETE',
+
+  headers: headers
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+

+
require 'rest-client'
+require 'json'
+
+headers = {
+  'Authorization' => 'API_KEY'
+}
+
+result = RestClient.delete '/api/boards/{board}/swimlanes/{swimlane}',
+  params: {
+  }, headers: headers
+
+p JSON.parse(result)
+
+

+
import requests
+headers = {
+  'Authorization': 'API_KEY'
+}
+
+r = requests.delete('/api/boards/{board}/swimlanes/{swimlane}', params={
+
+}, headers = headers)
+
+print r.json()
+
+

+
URL obj = new URL("/api/boards/{board}/swimlanes/{swimlane}");
+HttpURLConnection con = (HttpURLConnection) obj.openConnection();
+con.setRequestMethod("DELETE");
+int responseCode = con.getResponseCode();
+BufferedReader in = new BufferedReader(
+    new InputStreamReader(con.getInputStream()));
+String inputLine;
+StringBuffer response = new StringBuffer();
+while ((inputLine = in.readLine()) != null) {
+    response.append(inputLine);
+}
+in.close();
+System.out.println(response.toString());
+
+

+
package main
+
+import (
+       "bytes"
+       "net/http"
+)
+
+func main() {
+
+    headers := map[string][]string{
+        "Authorization": []string{"API_KEY"},
+        
+    }
+
+    data := bytes.NewBuffer([]byte{jsonReq})
+    req, err := http.NewRequest("DELETE", "/api/boards/{board}/swimlanes/{swimlane}", data)
+    req.Header = headers
+
+    client := &http.Client{}
+    resp, err := client.Do(req)
+    // ...
+}
+
+

+
DELETE /api/boards/{board}/swimlanes/{swimlane}

+
Parameters

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameInTypeRequiredDescription
boardpathstringtruethe board value
swimlanepathstringtruethe swimlane value

+
Responses

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
StatusMeaningDescriptionSchema
200OK200 responseNone

+
+
Schemas

+
Boards

+

+
{
+  "title": "string",
+  "slug": "string",
+  "archived": true,
+  "createdAt": "string",
+  "modifiedAt": "string",
+  "stars": 0,
+  "labels": [
+    {
+      "_id": "string",
+      "name": "string",
+      "color": "green"
+    }
+  ],
+  "members": [
+    {
+      "userId": "string",
+      "isAdmin": true,
+      "isActive": true,
+      "isNoComments": true,
+      "isCommentOnly": true,
+      "isWorker": true
+    }
+  ],
+  "permission": "public",
+  "color": "belize",
+  "description": "string",
+  "subtasksDefaultBoardId": "string",
+  "subtasksDefaultListId": "string",
+  "dateSettingsDefaultBoardId": "string",
+  "dateSettingsDefaultListId": "string",
+  "allowsSubtasks": true,
+  "allowsAttachments": true,
+  "allowsChecklists": true,
+  "allowsComments": true,
+  "allowsDescriptionTitle": true,
+  "allowsDescriptionText": true,
+  "allowsActivities": true,
+  "allowsLabels": true,
+  "allowsAssignee": true,
+  "allowsMembers": true,
+  "allowsRequestedBy": true,
+  "allowsAssignedBy": true,
+  "allowsReceivedDate": true,
+  "allowsStartDate": true,
+  "allowsEndDate": true,
+  "allowsDueDate": true,
+  "presentParentTask": "prefix-with-full-path",
+  "startAt": "string",
+  "dueAt": "string",
   "endAt": "string",
   "spentTime": 0,
   "isOvertime": true,
@@ -10402,7 +13690,544 @@ UserSecurity
 }
 
 

-
This is a Board.

+
This is a Board.

+
Properties

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameTypeRequiredRestrictionsDescription
titlestringtruenoneThe title of the board
slugstringtruenoneThe title slugified.
archivedbooleantruenoneIs the board archived?
createdAtstringtruenoneCreation time of the board
modifiedAtstring|nullfalsenoneLast modification time of the board
starsnumbertruenoneHow many stars the board has
labels[BoardsLabels]truenoneList of labels attached to a board
members[BoardsMembers]truenoneList of members of a board
permissionstringtruenonevisibility of the board
colorstringtruenoneThe color of the board.
descriptionstring|nullfalsenoneThe description of the board
subtasksDefaultBoardIdstring|nullfalsenoneThe default board ID assigned to subtasks.
subtasksDefaultListIdstring|nullfalsenoneThe default List ID assigned to subtasks.
dateSettingsDefaultBoardIdstring|nullfalsenonenone
dateSettingsDefaultListIdstring|nullfalsenonenone
allowsSubtasksbooleantruenoneDoes the board allows subtasks?
allowsAttachmentsbooleantruenoneDoes the board allows attachments?
allowsChecklistsbooleantruenoneDoes the board allows checklists?
allowsCommentsbooleantruenoneDoes the board allows comments?
allowsDescriptionTitlebooleantruenoneDoes the board allows description title?
allowsDescriptionTextbooleantruenoneDoes the board allows description text?
allowsActivitiesbooleantruenoneDoes the board allows comments?
allowsLabelsbooleantruenoneDoes the board allows labels?
allowsAssigneebooleantruenoneDoes the board allows assignee?
allowsMembersbooleantruenoneDoes the board allows members?
allowsRequestedBybooleantruenoneDoes the board allows requested by?
allowsAssignedBybooleantruenoneDoes the board allows requested by?
allowsReceivedDatebooleantruenoneDoes the board allows received date?
allowsStartDatebooleantruenoneDoes the board allows start date?
allowsEndDatebooleantruenoneDoes the board allows end date?
allowsDueDatebooleantruenoneDoes the board allows due date?
presentParentTaskstring|nullfalsenoneControls how to present the parent task:  - prefix-with-full-path: add a prefix with the full path - prefix-with-parent: add a prefisx with the parent name - subtext-with-full-path: add a subtext with the full path - subtext-with-parent: add a subtext with the parent name - no-parent: does not show the parent at all
startAtstring|nullfalsenoneStarting date of the board.
dueAtstring|nullfalsenoneDue date of the board.
endAtstring|nullfalsenoneEnd date of the board.
spentTimenumber|nullfalsenoneTime spent in the board.
isOvertimeboolean|nullfalsenoneIs the board overtimed?
typestringtruenoneThe type of board
sortnumbertruenoneSort value

+
Enumerated Values

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
PropertyValue
permissionpublic
permissionprivate
colorbelize
colornephritis
colorpomegranate
colorpumpkin
colorwisteria
colormoderatepink
colorstrongcyan
colorlimegreen
colormidnight
colordark
colorrelax
colorcorteza
presentParentTaskprefix-with-full-path
presentParentTaskprefix-with-parent
presentParentTasksubtext-with-full-path
presentParentTasksubtext-with-parent
presentParentTaskno-parent

+
BoardsLabels

+

+
{
+  "_id": "string",
+  "name": "string",
+  "color": "green"
+}
+
+

+
Properties

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameTypeRequiredRestrictionsDescription
_idstringtruenoneUnique id of a label
namestringfalsenoneName of a label
colorstringtruenonecolor of a label.  Can be amongst green, yellow, orange, red, purple, blue, sky, lime, pink, black, silver, peachpuff, crimson, plum, darkgreen, slateblue, magenta, gold, navy, gray, saddlebrown, paleturquoise, mistyrose, indigo

+
Enumerated Values

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
PropertyValue
colorgreen
coloryellow
colororange
colorred
colorpurple
colorblue
colorsky
colorlime
colorpink
colorblack
colorsilver
colorpeachpuff
colorcrimson
colorplum
colordarkgreen
colorslateblue
colormagenta
colorgold
colornavy
colorgray
colorsaddlebrown
colorpaleturquoise
colormistyrose
colorindigo

+
BoardsMembers

+

+
{
+  "userId": "string",
+  "isAdmin": true,
+  "isActive": true,
+  "isNoComments": true,
+  "isCommentOnly": true,
+  "isWorker": true
+}
+
+

 
Properties

 
@@ -10416,270 +14241,358 @@ UserSecurity
 
-
+
-
+
-
-
+
+
-
+
-
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
+
+
+

 
 
 
titleuserId
 string
 true
 noneThe title of the boardThe uniq ID of the member
 

 
slugstringisAdminboolean
 true
 noneThe title slugified.Is the member an admin of the board?
 

 
archivedisActive
 boolean
 true
 noneIs the board archived?Is the member active?
 

 
createdAtstringtrueisNoCommentsbooleanfalse
 noneCreation time of the boardIs the member not allowed to make comments
 

 
modifiedAtstring|nullisCommentOnlyboolean
 false
 noneLast modification time of the boardIs the member only allowed to comment on the board
 

 
starsnumbertrueisWorkerbooleanfalse
 noneHow many stars the board hasIs the member only allowed to move card, assign himself to card and comment

+
CardComments

+

+
{
+  "boardId": "string",
+  "cardId": "string",
+  "text": "string",
+  "createdAt": "string",
+  "modifiedAt": "string",
+  "userId": "string"
+}
+
+

+
A comment on a card

+
Properties

+
+
+
+
+
+
+
+
+
+
-
-
+
+
-
+
-
-
+
+
-
+
-
+
-
+
-
+
-
+
-
-
-
+
+
+
-
-
-
-
-
-
-
-
-
-
+
+
+
-
+
+
+
NameTypeRequiredRestrictionsDescription
 

 
labels[BoardsLabels]boardIdstring
 true
 noneList of labels attached to a boardthe board ID
 

 
members[BoardsMembers]cardIdstring
 true
 noneList of members of a boardthe card ID
 

 
permissiontext
 string
 true
 nonevisibility of the boardthe text of the comment
 

 
colorcreatedAt
 string
 true
 noneThe color of the board.when was the comment created
 

 
descriptionstring|nullfalsemodifiedAtstringtrue
 noneThe description of the board
subtasksDefaultBoardIdstring|nullfalse
 noneThe default board ID assigned to subtasks.
 

 
subtasksDefaultListIdstring|nullfalseuserIdstringtrue
 noneThe default List ID assigned to subtasks.the author ID of the comment
 

+
Cards

+

+
{
+  "title": "string",
+  "archived": true,
+  "parentId": "string",
+  "listId": "string",
+  "swimlaneId": "string",
+  "boardId": "string",
+  "coverId": "string",
+  "color": "white",
+  "createdAt": "string",
+  "modifiedAt": "string",
+  "customFields": [
+    {}
+  ],
+  "dateLastActivity": "string",
+  "description": "string",
+  "requestedBy": "string",
+  "assignedBy": "string",
+  "labelIds": [
+    "string"
+  ],
+  "members": [
+    "string"
+  ],
+  "assignees": [
+    "string"
+  ],
+  "receivedAt": "string",
+  "startAt": "string",
+  "dueAt": "string",
+  "endAt": "string",
+  "spentTime": 0,
+  "isOvertime": true,
+  "userId": "string",
+  "sort": 0,
+  "subtaskSort": 0,
+  "type": "string",
+  "linkedId": "string",
+  "vote": {
+    "question": "string",
+    "positive": [
+      "string"
+    ],
+    "negative": [
+      "string"
+    ],
+    "end": "string",
+    "public": true
+  }
+}
+
+

+
Properties

+
+
-
-
-
-
-
+
+
+
+
+
+
+
-
+
-
+
-
+
-
+
-
-
-
+
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
+
+
+
+
+
+
+
-
-
-
+
+
+
-
+
-
-
-
+
+
+
+
-
-
-
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
-
+
+
+
-
+
-
-
-
+
+
+
-
+
-
-
-
+
+
+
-
+
-
-
-
+
+
+
-
+
-
-
-
+
+
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -10688,136 +14601,33 @@ UserSecurity
 
-
-

 
dateSettingsDefaultBoardIdstring|nullfalsenonenoneNameTypeRequiredRestrictionsDescription
 

 
dateSettingsDefaultListIdtitle
 string|null
 false
 nonenonethe title of the card
 

 
allowsSubtasksarchived
 boolean
 true
 noneDoes the board allows subtasks?is the card archived
 

 
allowsAttachmentsbooleantrueparentIdstring|nullfalse
 noneDoes the board allows attachments?ID of the parent card
 

 
allowsChecklistsbooleantruelistIdstring|nullfalse
 noneDoes the board allows checklists?List ID where the card is
 

 
allowsCommentsbooleanswimlaneIdstring
 true
 noneDoes the board allows comments?Swimlane ID where the card is
boardIdstring|nullfalsenoneBoard ID of the card
 

 
allowsDescriptionTitlebooleantruecoverIdstring|nullfalse
 noneDoes the board allows description title?Cover ID of the card
 

 
allowsDescriptionTextbooleantruecolorstring|nullfalsenone
 noneDoes the board allows description text?
 

 
allowsActivitiesbooleancreatedAtstring
 true
 noneDoes the board allows comments?creation date
 

 
allowsLabelsbooleanmodifiedAtstring
 true
 noneDoes the board allows labels?none
 

 
allowsAssigneebooleantruecustomFields[CardsCustomfields]|nullfalse
 noneDoes the board allows assignee?list of custom fields
 

 
allowsMembersbooleandateLastActivitystring
 true
 noneDoes the board allows members?Date of last activity
 

 
allowsRequestedBybooleantruedescriptionstring|nullfalse
 noneDoes the board allows requested by?description of the card
 

 
allowsAssignedBybooleantruerequestedBystring|nullfalse
 noneDoes the board allows requested by?who requested the card (ID of the user)
 

 
allowsReceivedDatebooleantrueassignedBystring|nullfalse
 noneDoes the board allows received date?who assigned the card (ID of the user)
 

 
allowsStartDatebooleantruelabelIds[string]|nullfalse
 noneDoes the board allows start date?list of labels ID the card has
 

 
allowsEndDatebooleantruemembers[string]|nullfalse
 noneDoes the board allows end date?list of members (user IDs)
 

 
allowsDueDatebooleantrueassignees[string]|nullfalse
 noneDoes the board allows due date?who is assignee of the card (user ID), maximum one ID of assignee in array.
 

 
presentParentTaskreceivedAt
 string|null
 false
 noneControls how to present the parent task:  - prefix-with-full-path: add a prefix with the full path - prefix-with-parent: add a prefisx with the parent name - subtext-with-full-path: add a subtext with the full path - subtext-with-parent: add a subtext with the parent name - no-parent: does not show the parent at allDate the card was received
 

 

 startAt
 string|null
 false
 noneStarting date of the board.Date the card was started to be worked on
 

 

 dueAt
 string|null
 false
 noneDue date of the board.Date the card is due
 

 

 endAt
 string|null
 false
 noneEnd date of the board.Date the card ended
 

 

 spentTime
 number|null
 false
 noneTime spent in the board.How much time has been spent on this
 

 

 isOvertime
 boolean|null
 false
 noneIs the board overtimed?is the card over time?
 

 
typeuserId
 string
 true
 noneThe type of boarduser ID of the author of the card
 

 

 sortnone
 Sort value
 

-
Enumerated Values

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
PropertyValue
permissionpublic
permissionprivate
colorbelize
colornephritis
colorpomegranate
colorpumpkin
colorwisteria
colormoderatepink
colorstrongcyan
colorlimegreen
colormidnight
colordark
colorrelax
colorcorteza
presentParentTaskprefix-with-full-path
presentParentTaskprefix-with-parent
presentParentTasksubtext-with-full-path
presentParentTasksubtext-with-parent
presentParentTaskno-parent

-
BoardsLabels

-

-
{
-  "_id": "string",
-  "name": "string",
-  "color": "green"
-}
-
-

-
Properties

-
-
-
-
-
-
-
+
+
+
+
+
-
-
-
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+

 
NameTypeRequiredRestrictionsDescriptionsubtaskSortnumber|nullfalsenonesubtask sort value
 

 
_idtype
 string
 true
 noneUnique id of a labeltype of the card
 

 
namestringlinkedIdstring|null
 false
 noneName of a labelID of the linked card
 

 
colorstringtruevoteCardsVotefalse
 nonecolor of a label.  Can be amongst green, yellow, orange, red, purple, blue, sky, lime, pink, black, silver, peachpuff, crimson, plum, darkgreen, slateblue, magenta, gold, navy, gray, saddlebrown, paleturquoise, mistyrose, indigovote object, see below
 

 
 

@@ -10832,6 +14642,10 @@ UserSecurity
 
 
 color
+white
+
+
+color
 green
 
 
@@ -10919,27 +14733,100 @@ UserSecurity
 paleturquoise
 
 
-color
-mistyrose
+color
+mistyrose
+
+
+color
+indigo
+
+
+
+
CardsVote

+

+
{
+  "question": "string",
+  "positive": [
+    "string"
+  ],
+  "negative": [
+    "string"
+  ],
+  "end": "string",
+  "public": true
+}
+
+

+
Properties

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+
+
+
NameTypeRequiredRestrictionsDescription
questionstringtruenonenone
positive[string]falsenonelist of members (user IDs)
negative[string]falsenonelist of members (user IDs)
endstringfalsenonenone
 

 
colorindigopublicbooleantruenonenone
 

 
 

-
BoardsMembers

-

+
CardsCustomfields

+

+
{}
+
+

+
Properties

+
None

+
ChecklistItems

+

 
{
-  "userId": "string",
-  "isAdmin": true,
-  "isActive": true,
-  "isNoComments": true,
-  "isCommentOnly": true,
-  "isWorker": true
+  "title": "string",
+  "sort": 0,
+  "isFinished": true,
+  "checklistId": "string",
+  "cardId": "string",
+  "createdAt": "string",
+  "modifiedAt": "string"
 }
 
 

+
An item in a checklist

 
Properties

 
@@ -10953,62 +14840,69 @@ UserSecurity
 
-
+
-
+
-
-
+
+
-
+
-
+
-
+
-
-
-
+
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
+
+
+
+
+
+
+

 
 
 
userIdtitle
 string
 true
 noneThe uniq ID of the memberthe text of the item
 

 
isAdminbooleansortnumber
 true
 noneIs the member an admin of the board?the sorting field of the item
 

 
isActiveisFinished
 boolean
 true
 noneIs the member active?Is the item checked?
 

 
isNoCommentsbooleanfalsechecklistIdstringtrue
 noneIs the member not allowed to make commentsthe checklist ID the item is attached to
 

 
isCommentOnlybooleanfalsecardIdstringtrue
 noneIs the member only allowed to comment on the boardthe card ID the item is attached to
 

 
isWorkerbooleancreatedAtstring|null
 false
 noneIs the member only allowed to move card, assign himself to card and commentnone
modifiedAtstringtruenonenone
 

 
 

-
CardComments

-

+
Checklists

+

 
{
-  "boardId": "string",
   "cardId": "string",
-  "text": "string",
+  "title": "string",
+  "finishedAt": "string",
   "createdAt": "string",
   "modifiedAt": "string",
-  "userId": "string"
+  "sort": 0
 }
 
 

-
A comment on a card

+
A Checklist

 
Properties

 
@@ -11022,32 +14916,32 @@ UserSecurity
 
-
+
-
+
-
+
-
+
-
-
-
+
+
+
-
+
-
+
@@ -11057,28 +14951,36 @@ UserSecurity
 
-
-
+
+
-
+

 
 
 
boardIdcardId
 string
 true
 nonethe board IDThe ID of the card the checklist is in
 

 
cardIdtitle
 string
 true
 nonethe card IDthe title of the checklist
 

 
textstringtruefinishedAtstring|nullfalse
 nonethe text of the commentWhen was the checklist finished
 

 

 createdAt
 string
 true
 nonewhen was the comment createdCreation date of the checklist
 

 

 modifiedAtnone
 

 
userIdstringsortnumber
 true
 nonethe author ID of the commentsorting value of the checklist
 

 
 

-
ChecklistItems

-

+
CustomFields

+

 
{
-  "title": "string",
-  "sort": 0,
-  "isFinished": true,
-  "checklistId": "string",
-  "cardId": "string",
+  "boardIds": [
+    "string"
+  ],
+  "name": "string",
+  "type": "text",
+  "settings": {
+    "dropdownItems": [
+      {}
+    ]
+  },
+  "showOnCard": true,
+  "automaticallyOnCard": true,
+  "showLabelOnMiniCard": true,
   "createdAt": "string",
   "modifiedAt": "string"
 }
 
 

-
An item in a checklist

+
A custom field on a card in the board

 
Properties

 
@@ -11092,39 +14994,53 @@ UserSecurity
 
-
+
+
+
+
+
+
+
+
-
+
-
-
+
+
-
+
-
+
+
+
+
+
+
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
@@ -11142,19 +15058,89 @@ UserSecurity
 

 
 
 
titleboardIds[string]truenonethe ID of the board
name
 string
 true
 nonethe text of the itemname of the custom field
 

 
sortnumbertypestring
 true
 nonethe sorting field of the itemtype of the custom field
 

 
isFinishedsettingsCustomFieldsSettingstruenonesettings of the custom field
showOnCard
 boolean
 true
 noneIs the item checked?should we show on the cards this custom field
 

 
checklistIdstringautomaticallyOnCardboolean
 true
 nonethe checklist ID the item is attached toshould the custom fields automatically be added on cards?
 

 
cardIdstringshowLabelOnMiniCardboolean
 true
 nonethe card ID the item is attached toshould the label of the custom field be shown on minicards?
 

 

 createdAt

 
 

-
Checklists

-

+
Enumerated Values

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
PropertyValue
typetext
typenumber
typedate
typedropdown

+
CustomFieldsSettings

+

 
{
-  "cardId": "string",
+  "dropdownItems": [
+    {}
+  ]
+}
+
+

+
Properties

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
NameTypeRequiredRestrictionsDescription
dropdownItems[CustomFieldsSettingsDropdownitems]falsenonelist of drop down items objects

+
CustomFieldsSettingsDropdownitems

+

+
{}
+
+

+
Properties

+
None

+
Integrations

+

+
{
+  "enabled": true,
   "title": "string",
-  "finishedAt": "string",
+  "type": "string",
+  "activities": [
+    "string"
+  ],
+  "url": "string",
+  "token": "string",
+  "boardId": "string",
   "createdAt": "string",
   "modifiedAt": "string",
-  "sort": 0
+  "userId": "string"
 }
 
 

-
A Checklist

+
Integration with third-party applications

 
Properties

 
@@ -11168,32 +15154,60 @@ UserSecurity
 
-
-
+
+
-
+
+
+
+
+
+
+
+
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
+
+
+
+
+
+
-
+
@@ -11203,36 +15217,37 @@ UserSecurity
 
-
-
+
+
-
+

 
 
 
cardIdstringenabledboolean
 true
 noneThe ID of the card the checklist is inis the integration enabled?
 

 

 titlestring|nullfalsenonename of the integration
type
 string
 true
 nonethe title of the checklisttype of the integratation (Default to 'outgoing-webhooks')
 

 
finishedAtactivities[string]truenoneactivities the integration gets triggered (list)
urlstringtruenonenone
token
 string|null
 false
 noneWhen was the checklist finishedtoken of the integration
boardIdstringtruenoneBoard ID of the integration
 

 

 createdAt
 string
 true
 noneCreation date of the checklistCreation date of the integration
 

 

 modifiedAtnone
 

 
sortnumberuserIdstring
 true
 nonesorting value of the checklistuser ID who created the interation
 

 
 

-
CustomFields

-

+
Lists

+

 
{
-  "boardIds": [
-    "string"
-  ],
-  "name": "string",
-  "type": "text",
-  "settings": {
-    "dropdownItems": [
-      {}
-    ]
-  },
-  "showOnCard": true,
-  "automaticallyOnCard": true,
-  "showLabelOnMiniCard": true,
+  "title": "string",
+  "starred": true,
+  "archived": true,
+  "boardId": "string",
+  "swimlaneId": "string",
   "createdAt": "string",
-  "modifiedAt": "string"
+  "sort": 0,
+  "updatedAt": "string",
+  "modifiedAt": "string",
+  "wipLimit": {
+    "value": 0,
+    "enabled": true,
+    "soft": true
+  },
+  "color": "white",
+  "type": "string"
 }
 
 

-
A custom field on a card in the board

+
A list (column) in the Wekan board.

 
Properties

 
@@ -11246,60 +15261,60 @@ UserSecurity
 
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
-
+
+
+
-
+
-
+
-
+
@@ -11308,6 +15323,27 @@ UserSecurity
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

 
 
 
boardIds[string]titlestring
 true
 nonethe ID of the boardthe title of the list
 

 
namestringtruestarredboolean|nullfalse
 nonename of the custom fieldif a list is stared then we put it on the top
 

 
typestringarchivedboolean
 true
 nonetype of the custom fieldis the list archived
 

 
settingsCustomFieldsSettingsboardIdstring
 true
 nonesettings of the custom fieldthe board associated to this list
 

 
showOnCardbooleanswimlaneIdstring
 true
 noneshould we show on the cards this custom fieldthe swimlane associated to this list. Used for templates
 

 
automaticallyOnCardbooleancreatedAtstring
 true
 noneshould the custom fields automatically be added on cards?creation date
 

 
showLabelOnMiniCardbooleantruesortnumber|nullfalse
 noneshould the label of the custom field be shown on minicards?is the list sorted
 

 
createdAtupdatedAt
 string|null
 false
 nonenonelast update of the list
 

 

 modifiedAtnone
 none
 
wipLimitListsWiplimitfalsenoneWIP object, see below
colorstring|nullfalsenonethe color of the list
typestringtruenoneThe type of list

 
 

 
Enumerated Values

@@ -11320,79 +15356,112 @@ UserSecurity
 
 
 
-type
-text
+color
+white
 
 
-type
-number
+color
+green
 
 
-type
-date
+color
+yellow
 
 
-type
-dropdown
+color
+orange
+
+
+color
+red
+
+
+color
+purple
+
+
+color
+blue
+
+
+color
+sky
+
+
+color
+lime
+
+
+color
+pink
+
+
+color
+black
+
+
+color
+peachpuff
+
+
+color
+crimson
+
+
+color
+plum
+
+
+color
+darkgreen
+
+
+color
+slateblue
+
+
+color
+magenta
+
+
+color
+gold
+
+
+color
+navy
+
+
+color
+gray
+
+
+color
+saddlebrown
 
-
-
-
CustomFieldsSettings

-

-
{
-  "dropdownItems": [
-    {}
-  ]
-}
-
-

-
Properties

-
-
-
-
-
-
-
+
+
-
-
-
-
-
-
-
+
+
+
+
+
+

 
NameTypeRequiredRestrictionsDescriptioncolorpaleturquoise
 

 
dropdownItems[CustomFieldsSettingsDropdownitems]falsenonelist of drop down items objectscolormistyrose
colorindigo
 

 
 

-
CustomFieldsSettingsDropdownitems

-

-
{}
-
-

-
Properties

-
None

-
Integrations

-

+
ListsWiplimit

+

 
{
+  "value": 0,
   "enabled": true,
-  "title": "string",
-  "type": "string",
-  "activities": [
-    "string"
-  ],
-  "url": "string",
-  "token": "string",
-  "boardId": "string",
-  "createdAt": "string",
-  "modifiedAt": "string",
-  "userId": "string"
+  "soft": true
 }
 
 

-
Integration with third-party applications

 
Properties

 
@@ -11406,100 +15475,44 @@ UserSecurity
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+

 
 
 
enabledbooleantruenoneis the integration enabled?
titlestring|nullfalsenonename of the integration
typestringtruenonetype of the integratation (Default to 'outgoing-webhooks')
activities[string]truenoneactivities the integration gets triggered (list)
urlstringtruenonenone
tokenstring|nullfalsenonetoken of the integration
boardIdstringtruenoneBoard ID of the integration
createdAtstringvaluenumber
 true
 noneCreation date of the integrationvalue of the WIP
 

 
modifiedAtstringenabledboolean
 true
 nonenoneis the WIP enabled
 

 
userIdstringsoftboolean
 true
 noneuser ID who created the interationis the WIP a soft or hard requirement
 

 
 

-
Lists

-

+
Swimlanes

+

 
{
   "title": "string",
-  "starred": true,
   "archived": true,
   "boardId": "string",
-  "swimlaneId": "string",
   "createdAt": "string",
   "sort": 0,
+  "color": "white",
   "updatedAt": "string",
   "modifiedAt": "string",
-  "wipLimit": {
-    "value": 0,
-    "enabled": true,
-    "soft": true
-  },
-  "color": "white",
   "type": "string"
 }
 
 

-
A list (column) in the Wekan board.

+
A swimlane is an line in the kaban board.

 
Properties

 
@@ -11517,56 +15530,49 @@ UserSecurity
 
-
-
-
-
-
-
-
-
+
-
+
-
-
-
-
-
-
-
-
+
-
+
-
+
+
+
+
+
+
+
+
-
+
@@ -11576,25 +15582,11 @@ UserSecurity
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+

 
string
 true
 nonethe title of the list
starredboolean|nullfalsenoneif a list is stared then we put it on the topthe title of the swimlane
 

 

 archived
 boolean
 true
 noneis the list archivedis the swimlane archived?
 

 

 boardId
 string
 true
 nonethe board associated to this list
swimlaneIdstringtruenonethe swimlane associated to this list. Used for templatesthe ID of the board the swimlane is attached to
 

 

 createdAt
 string
 true
 nonecreation datecreation date of the swimlane
 

 

 sort
 number|null
 false
 noneis the list sortedthe sort value of the swimlane
colorstring|nullfalsenonethe color of the swimlane
 

 

 updatedAt
 string|null
 false
 nonelast update of the listwhen was the swimlane last edited
 

 

 modifiedAtnone
 

 
wipLimitListsWiplimitfalsenoneWIP object, see below
colorstring|nullfalsenonethe color of the list

 type
 string
 true
 noneThe type of listThe type of swimlane
 

 
 

@@ -11672,45 +15664,187 @@ UserSecurity
 slateblue
 
 
-color
-magenta
+color
+magenta
+
+
+color
+gold
+
+
+color
+navy
+
+
+color
+gray
+
+
+color
+saddlebrown
+
+
+color
+paleturquoise
+
+
+color
+mistyrose
+
+
+color
+indigo
+
+
+
+
Users

+

+
{
+  "username": "string",
+  "emails": [
+    {
+      "address": "string",
+      "verified": true
+    }
+  ],
+  "createdAt": "string",
+  "modifiedAt": "string",
+  "profile": {
+    "avatarUrl": "string",
+    "emailBuffer": [
+      "string"
+    ],
+    "fullname": "string",
+    "showDesktopDragHandles": true,
+    "hiddenSystemMessages": true,
+    "hiddenMinicardLabelText": true,
+    "initials": "string",
+    "invitedBoards": [
+      "string"
+    ],
+    "language": "string",
+    "notifications": [],
+    "activity": "string",
+    "read": "string",
+    "showCardsCountAt": 0,
+    "startDayOfWeek": 0,
+    "starredBoards": [
+      "string"
+    ],
+    "icode": "string",
+    "boardView": "board-view-lists",
+    "listSortBy": "-modifiedat",
+    "templatesBoardId": "string",
+    "cardTemplatesSwimlaneId": "string",
+    "listTemplatesSwimlaneId": "string",
+    "boardTemplatesSwimlaneId": "string"
+  },
+  "services": {},
+  "heartbeat": "string",
+  "isAdmin": true,
+  "createdThroughApi": true,
+  "loginDisabled": true,
+  "authenticationMethod": "string"
+}
+
+

+
A User in wekan

+
Properties

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+
+
+
-
-
+
+
+
+
+
-
-
+
+
+
+
+
-
-
+
+
+
+
+
-
-
+
+
+
+
+
-
-
+
+
+
+
+
-
-
+
+
+
+
+
NameTypeRequiredRestrictionsDescription
usernamestring|nullfalsenonethe username of the user
emails[UsersEmails]|nullfalsenonethe list of emails attached to a user
createdAtstringtruenonecreation date of the user
modifiedAtstringtruenonenone
 

 
colorgoldprofileUsersProfilefalsenoneprofile settings
 

 
colornavyservicesobject|nullfalsenoneservices field of the user
 

 
colorgrayheartbeatstring|nullfalsenonelast time the user has been seen
 

 
colorsaddlebrownisAdminboolean|nullfalsenoneis the user an admin of the board?
 

 
colorpaleturquoisecreatedThroughApiboolean|nullfalsenonewas the user created through the API?
 

 
colormistyroseloginDisabledboolean|nullfalsenoneloginDisabled field of the user
 

 
colorindigoauthenticationMethodstringtruenoneauthentication method of the user
 

 
 

-
ListsWiplimit

-

+
UsersEmails

+

 
{
-  "value": 0,
-  "enabled": true,
-  "soft": true
+  "address": "string",
+  "verified": true
 }
 
 

@@ -11727,44 +15861,55 @@ UserSecurity
 
 
 
-value
-number
-true
-none
-value of the WIP
-
-
-enabled
-boolean
+address
+string
 true
 none
-is the WIP enabled
+The email address
 
 
-soft
+verified
 boolean
 true
 none
-is the WIP a soft or hard requirement
+Has the email been verified
 
 
 
-
Swimlanes

-

+
UsersProfile

+

 
{
-  "title": "string",
-  "archived": true,
-  "boardId": "string",
-  "createdAt": "string",
-  "sort": 0,
-  "color": "white",
-  "updatedAt": "string",
-  "modifiedAt": "string",
-  "type": "string"
+  "avatarUrl": "string",
+  "emailBuffer": [
+    "string"
+  ],
+  "fullname": "string",
+  "showDesktopDragHandles": true,
+  "hiddenSystemMessages": true,
+  "hiddenMinicardLabelText": true,
+  "initials": "string",
+  "invitedBoards": [
+    "string"
+  ],
+  "language": "string",
+  "notifications": [],
+  "activity": "string",
+  "read": "string",
+  "showCardsCountAt": 0,
+  "startDayOfWeek": 0,
+  "starredBoards": [
+    "string"
+  ],
+  "icode": "string",
+  "boardView": "board-view-lists",
+  "listSortBy": "-modifiedat",
+  "templatesBoardId": "string",
+  "cardTemplatesSwimlaneId": "string",
+  "listTemplatesSwimlaneId": "string",
+  "boardTemplatesSwimlaneId": "string"
 }
 
 

-
A swimlane is an line in the kaban board.

 
Properties

 
@@ -11778,217 +15923,248 @@ UserSecurity
 
-
+
-
+
-
+
-
-
-
+
+
+
-
+
-
+
-
+
-
+
-
-
-
+
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
+
+
-
+
-
-
-
-
+
+
+
+
-
+
-
+
-
-
-
-

 
 
 
titleavatarUrl
 stringtruefalse
 nonethe title of the swimlaneURL of the avatar of the user
 

 
archivedbooleantrueemailBuffer[string]false
 noneis the swimlane archived?list of email buffers of the user
 

 
boardIdfullname
 stringtruefalse
 nonethe ID of the board the swimlane is attached tofull name of the user
 

 
createdAtstringtrueshowDesktopDragHandlesbooleanfalse
 nonecreation date of the swimlanedoes the user want to hide system messages?
 

 
sortnumber|nullhiddenSystemMessagesboolean
 false
 nonethe sort value of the swimlanedoes the user want to hide system messages?
 

 
colorstring|nullhiddenMinicardLabelTextboolean
 false
 nonethe color of the swimlanedoes the user want to hide minicard label texts?
 

 
updatedAtstring|nullinitialsstring
 false
 nonewhen was the swimlane last editedinitials of the user
 

 
modifiedAtstringtruenoneinvitedBoards[string]false
 noneboard IDs the user has been invited to
 

 
typelanguage
 stringtruefalse
 noneThe type of swimlane

-
Enumerated Values

-
-
-
-
-
-
-
-
-
-
-
+
-
-
+
+
+
+
+
-
-
+
+
+
+
+
-
-
+
+
+
+
+
-
-
+
+
+
+
+
-
-
+
+
+
+
+
-
-
+
+
+
+
+
-
-
+
+
+
+
+
-
-
+
+
+
+
+
-
-
+
+
+
+
+
-
-
+
+
+
+
+
-
-
+
+
+
+
+
-
-
+
+
+
+
+
-
-
+
+
+
+
+
+
+
PropertyValue
colorwhitelanguage of the user
 

 
colorgreennotifications[UsersProfileNotifications]falsenoneenabled notifications for the user
 

 
coloryellowactivitystringtruenoneThe id of the activity this notification references
 

 
colororangereadstringfalsenonethe date on which this notification was read
 

 
colorredshowCardsCountAtnumberfalsenoneshowCardCountAt field of the user
 

 
colorpurplestartDayOfWeeknumberfalsenonestartDayOfWeek field of the user
 

 
colorbluestarredBoards[string]falsenonelist of starred board IDs
 

 
colorskyicodestringfalsenoneicode
 

 
colorlimeboardViewstringfalsenoneboardView field of the user
 

 
colorpinklistSortBystringfalsenonedefault sort list for user
 

 
colorblacktemplatesBoardIdstringtruenoneReference to the templates board
 

 
colorpeachpuffcardTemplatesSwimlaneIdstringtruenoneReference to the card templates swimlane Id
 

 
colorcrimsonlistTemplatesSwimlaneIdstringtruenoneReference to the list templates swimlane Id
 

 
colorplumboardTemplatesSwimlaneIdstringtruenoneReference to the board templates swimlane Id
 

+
Enumerated Values

+
+
-
-
+
+
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+
-
-
+
+

 
colordarkgreenPropertyValue
 

 
colorslateblueboardViewboard-view-lists
 

 
colormagentaboardViewboard-view-swimlanes
 

 
colorgoldboardViewboard-view-cal
 

 
colornavylistSortBy-modifiedat
 

 
colorgraylistSortBymodifiedat
 

 
colorsaddlebrownlistSortBy-title
 

 
colorpaleturquoiselistSortBytitle
 

 
colormistyroselistSortBy-sort
 

 
colorindigolistSortBysort
- +
- - + + Shell - - - + + + HTTP - - - + + + JavaScript - - - + + + Node.js - - - + + + Ruby - - - + + + Python - - - + + + Java - - - + + + Go - - + +
- +
-- cgit v1.2.3-1-g7c22