Category Lookup

An activity can have a 'Category' allocated to it. This API provides a list of valid categories. Note that the list of categories can be dependent on the activity type

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areaactivities.json
GeneralYesParameters described in overviewuser=user&password=user&version=3.9Overview
CompanyYesThe company numbercompany=1
ActionYesThe action to performaction=categories
Activity typeYesSpecify the activity typeactivitytype=MAIL

Example request:

http://<SERVER>/jsonapi/activities.json?user=user&password=user&company=1&action=categories&activitytype=MAIL&version=3.9

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 49,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "lookupTime": "00:00:00",
      "lookupTimeDisplay": "12:00 AM",
      "variable_selected": true
    },
    {
      "lookupTime": "00:30:00",
      "lookupTimeDisplay": "12:30 AM",
      "variable_selected": false
    },
    {
      "lookupTime": "01:00:00",
      "lookupTimeDisplay": "1:00 AM",
      "variable_selected": false
    },
    {
      "lookupTime": "01:30:00",
      "lookupTimeDisplay": "1:30 AM",
      "variable_selected": false
    },
    {  etc., etc