To get an ordered list of columns for a board (hardwired max 500 columns):
Parameter | Mandatory | Description | Examples | More Info |
---|---|---|---|---|
API | Yes | The API area | kanbanboard.json | |
General | Yes | Parameters described in overview | user=user&password=user | Structure of an API call |
Company | Yes | The company number | company=1 | |
Action | Yes | The action to perform | action=columns | |
Identifier | Yes | Kanban board UUID | uuid=31A20A6043A68C4ABB2F3F632054E0E3 |
Example request:
http://<SERVER>/jsonAPI/kanbanboard.json?user=user&password=user&version=3.9&uuid=31A20A6043A68C4ABB2F3F632054E0E3&action=columns
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 5,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"synversion": "12.9",
"synapiversion": 3.8,
"data": [
{
"kbcolumnUuid": "91D649A6FA10C14ABBCBEA0128AFEDEC",
"kbcolumnTimestampModified": 1602160298,
"kbcolumnRecordVersionNumber": 0,
"kbcolumnAllowAddNew": true,
"kbcolumnOrder": 1,
"kbcolumnStatusCode": "TODO",
"kbcolumnUserCanChangeKBEntityStatus": true,
"kbcolumnStatusColourHex": "C0FFFF",
"kbcolumnStatusAction": "U",
"kbcolumnStatusDescription": "To do ⚡"
},
{
"kbcolumnUuid": "C1A412F92C4A6746A88EAAAAFB38C12A",
"kbcolumnTimestampModified": 1602160311,
"kbcolumnRecordVersionNumber": 0,
"kbcolumnAllowAddNew": true,
"kbcolumnOrder": 2,
"kbcolumnStatusCode": "INPR",
"kbcolumnUserCanChangeKBEntityStatus": true,
"kbcolumnStatusColourHex": "FFFFA0",
"kbcolumnStatusAction": "U",
"kbcolumnStatusDescription": "In progress 🚀"
},