BIbigchange
Worksheets

Get a list of worksheets

Retrieve a paged collection of worksheets (required scope worksheets:read)

get/v1/worksheets

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/worksheets
  • Auth
    HTTP bearer

Query parameters

namestring

Only return worksheets where name matches or starts with the value provided

groupIdinteger[]

Only return worksheets that are part of the group with the provided groupId (Max items: 50)

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>

Example:worksheet

Only return worksheets of the selected type

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

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
}

Changes

No recorded changes to this operation across all 13 revisions of this API.