Kanban Board Columns

To get an ordered list of columns for a board (hardwired max 500 columns):

Kanban Board Columns

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areakanbanboard.json
GeneralYesParameters described in overviewAuthorization: Bearer <access_token> header — see Synergist API AuthenticationStructure of an API call
CompanyYesThe company numbercompany=1
ActionYesThe action to performaction=columns
IdentifierYesKanban board UUIDuuid=31A20A6043A68C4ABB2F3F632054E0E3

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://&lt;SERVER&gt;/jsonapi/kanbanboard.json?&version=6&uuid=31A20A6043A68C4ABB2F3F632054E0E3&action=columns

Example request (legacy username/password):

http://&lt;SERVER&gt;/jsonapi/kanbanboard.json?&version=6&uuid=31A20A6043A68C4ABB2F3F632054E0E3&action=columns&user=<username>&password=<password>

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 🚀"
    }
  ]
}