916e669fc527
Get a list of worksheets
Retrieve a paged collection of worksheets (required scope worksheets:read)
Query parameters
Only return worksheets where name matches or starts with the value provided
Only return worksheets that are part of the group with the provided groupId (Max items: 50)
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>
Only return worksheets of the selected type
The page number being requested (minimum: 1, maximum: 2147483)
The page size being requested (minimum: 1, maximum: 1000)
Headers
The customer identifier
Response
OK
Example response
{
"items": [
{
"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"
}
],
"pageNumber": 2,
"pageSize": 100,
"pageItemCount": 55
}