List Templates

Return a list of checklist templates

List Templates

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areachecklistheader.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=templates

Example request (OAuth 2.0):

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

Example request (legacy username/password):

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

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 3,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "checklistUuid": "B169DA9B3B5810448C5B2151FF232DB2",
      "checklistTimestampModified": 1533200270,
      "checklistRecordVersionNumber": 0,
      "checklistActivityID": 7906,
      "checklistTitle": "Standard CL1",
      "checklistActivityJobDesc": "Template for checklists",
      "checklistActivityJobNumber": "1/CH00ECK1",
      "checklistActivitySubject": "Standard checklists 1"
    },
    {
      "checklistUuid": "F9ED26457F3ECD4AB55A0B04DF223278",
      "checklistTimestampModified": 1533200302,
      "checklistRecordVersionNumber": 0,
      "checklistActivityID": 7906,
      "checklistTitle": "Standard CL2",
      "checklistActivityJobDesc": "Template for checklists",
      "checklistActivityJobNumber": "1/CH00ECK1",
      "checklistActivitySubject": "Standard checklists 1"
    }
  ]
}