---
title: "Get a list of worksheets"
method: GET
path: "/v1/worksheets"
tags: ["Worksheets"]
---

# Get a list of worksheets

`GET /v1/worksheets`

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

## Query parameters

- `name` string
- `groupId` integer[]
- `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>
- `pageNumber` integer
- `pageSize` integer

## Headers

- `Customer-Id` integer, required

## Response `200`

OK

- PagedResponseReadWorksheetModel — A paged collection of items
  - `items` ReadWorksheetModel[] — The items returned for the requested page
    - `id` integer — The unique identifier of the worksheet
    - `name` string — The name of the worksheet
    - `modifiedAt` string, date-time — The UTC timestamp of when this worksheet was modified
    - `groupId` integer, nullable — The unique identifier of the worksheet group
    - `isSharedWithContractors` boolean — 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>
    - `answerHeadingLabel` string — The label associated with the worksheet answer heading
    - `notesHeadingLabel` string — The label associated with the worksheet notes heading
  - `pageNumber` integer — The page number of the response where 1 is the first page
  - `pageSize` integer — The number of items requested for the current page
  - `pageItemCount` integer — The number of items returned in the current page

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.net/bigchange/apis/bigchange-dx.md) · [All operations](https://skmtc.net/bigchange/apis/bigchange-dx/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bigchange/bigchange-dx/revisions/916e669fc527/schema)