Activity Type Lookup

Activity type is mandatory when creating an activity. This API provides a lookup list of valid activity types.

Activity Type Lookup

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areaactivities.json
GeneralYesParameters described in API syntax sectionStructure of an API call
CompanyYesThe company numbercompany=1
ActionYesThe action to performaction=activitytypes
JobNoJob numberjob=1/00088972
JobphaseNoJob and phase numberjobphase=1/00088972.001
ActivitytypeNoActivity typeactivitytype=MEET

If you are supporting requisition type activities, you need to pass either the job or jobphase parameter.

Example request (OAuth 2.0):

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

Example request (legacy username/password):

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

Example response:

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