Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Worksheets

Get a worksheet

Retrieve the details of a single worksheet (required scope worksheets:read)

get/v1/worksheets/{worksheetId}

Path parameters

worksheetIdinteger required

The unique identifier of the worksheet

Headers

Customer-Idinteger required

The customer identifier

Response

OK

idinteger

The unique identifier of the worksheet

namestring

The name of the worksheet

modifiedAtstring date-time

The UTC timestamp of when this worksheet was modified

groupIdinteger nullable

The unique identifier of the worksheet group

isSharedWithContractorsboolean

Indicates whether the worksheet will be shared with contractors

type'worksheet' | 'workflow' | 'worksheetActivity' | 'worksheetDefect'

Enumeration representing different types of worksheets<p>Possible values:</p><ul><li><b>worksheet</b>: Data collected through the digital questionnaires associated with a job</li><li><b>workflow</b>: Data collected through the digital questionnaires associated with a note</li><li><b>worksheetActivity</b>: Data collected through the digital questionnaires associated with the timesheet acitivities</li><li><b>worksheetDefect</b>: The records of inspections performed on a vehicle using the vehicle check worksheets. Note that legacy ticksheets are not included in this</li></ul>

answerHeadingLabelstring

The label associated with the worksheet answer heading

notesHeadingLabelstring

The label associated with the worksheet notes heading

Example response

{
  "id": 12345,
  "name": "Boiler Install",
  "modifiedAt": "2022-11-29T16:50:16.0000000+00:00",
  "groupId": 12345,
  "type": "worksheet",
  "answerHeadingLabel": "Please answer here",
  "notesHeadingLabel": "Please add any notes here"
}