Kanban Activity Types

List available activity types on Kanban activity record

Kanban Activity Types

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=activitytypes

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://&lt;SERVER&gt;/jsonapi/kanbanboard.json?&version=6&company=1&action=activitytypes

Example request (legacy username/password):

http://&lt;SERVER&gt;/jsonapi/kanbanboard.json?&version=6&company=1&action=activitytypes&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 26,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "synapiversion": 3.8,
  "data": [
    {
      "activitytypeActive": true,
      "activitytypeNoteCategory": 2,
      "activitytypeCode": "1/ARTWORK",
      "activitytypeCompletionAlertByDefault": false,
      "activitytypeDescription": "Artwork 1",
      "activitytypeDisplayOrder": "",
      "activitytypeHideReqFields": false,
      "activitytypeImmediateAlertOnByDefault": false,
      "variable_selected": false
    },
    {
      "activitytypeActive": true,
      "activitytypeNoteCategory": 2,
      "activitytypeCode": "1/CBA",
      "activitytypeCompletionAlertByDefault": false,
      "activitytypeDescription": "Calendar Booking Activity",
      "activitytypeDisplayOrder": "",
      "activitytypeHideReqFields": false,
      "activitytypeImmediateAlertOnByDefault": false,
      "variable_selected": false
    }
  ]
}