To get an ordered list of entities for a board (hardcoded max 500 entities):
Kanban Board Entities
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | kanbanboard.json | |
| General | Yes | Parameters described in overview | Authorization: Bearer <access_token> header — see Synergist API Authentication | Structure of an API call |
| Board Uuid | Yes | Uuid of the kanban board header | uuid="31A20A6043A68C4ABB2F3F632054E0E3" | |
| View | Yes | Stored filter applied | view=-1700 | Using views |
| Company | Yes | The company number | company=1 | |
| Action | Yes | The action to perform | action=entities | |
| Date Range | No | Kanban Date Range | daterange=34 | |
| Kanban Status | No | Kanban Status | kanbanstatus=TODO | |
| Search | No | Kanban Search | search="note details" |
Example request (OAuth 2.0):
Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/kanbanboard.json?&version=6&company=1&action=entities&uuid="31A20A6043A68C4ABB2F3F632054E0E3"&view=-1700Example request (legacy username/password):
http://<SERVER>/jsonapi/kanbanboard.json?&version=6&company=1&action=entities&uuid="31A20A6043A68C4ABB2F3F632054E0E3"&view=-1700&user=<username>&password=<password>Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 293,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"kbentityAttachments": "11",
"kbentityAvatar": "/custom/User_611.jpg",
"kbentityCategory": 8,
"kbentityChargeCode": "",
"kbentityChargeCodeDescription": "",
"kbentityChecklistsItemsTotal": 0,
"kbentityChecklistsItemsComplete": 0,
"kbentityClientCode": "1/11223222",
"kbentityClientName": "Meadowside",
"kbentityColourHex": "AAAAAA",
"kbentityColumnOrder": 0,
"kbentityCommentsTotal": 0,
"kbentityCompany": 1,
"kbentityDateUtc": "2021-02-09",
"kbentityDescription": "Colum Test 2",
"kbentityDetails": "Colum Test 2",
"kbentityHeading": "10208",
"kbentityHoursRequested": 0,
"kbentityIsoDateTime": "2021-02-09T10:00:00Z",
"kbentityJob": "1/10700107",
"kbentityJobDescription1st": "andy",
"kbentityJobPhase": "1/10700107.001",
"kbentityJobPhaseSimple": "10700107.001",
"kbentityJobSimple": "10700107",
"kbentityKbTimeStamp": 1628663791,
"kbentityKbUserName": "Colum Hogan",
"kbentityOrder": 1638400,
"kbentityPhaseDescription1st": "Phase 1",
"kbentityPriorityDescription": "Med",
"kbentityResourceCode": "",
"kbentityResourceCodeDescription": "",
"kbentityStage": "",
"kbentityStageDescription": "",
"kbentityStartDateUtc": "2021-02-09",
"kbentityStartIsoDateTime": "2021-02-09T09:00:00Z",
"kbentityStartTimeUtc": "09:00:00",
"kbentityStatus": "OPEN",
"kbentityStatusCode": "INPROG1",
"kbentityTimeUtc": "10:00:00",
"kbentityType": "ACTIVITY",
"kbentityTypeCode": "1/REQ",
"kbentityTypeDescription": "Requisition",
"kbentityUserID": 611,
"kbentityUserName": "Colum Hogan",
"kbentityUserIsWatching": false,
"kbentityUuid": "600A2A865912BA479F4E630DE4F44C77"
}
]
}