---
title: "Get a collection of worksheet questions related to a worksheet"
method: GET
path: "/v1/worksheets/{worksheetId}/worksheetQuestions"
tags: ["Worksheets"]
---

# Get a collection of worksheet questions related to a worksheet

`GET /v1/worksheets/{worksheetId}/worksheetQuestions`

Retrieve the details of worksheet questions for a given worksheet (required scope worksheets:read)

## Path parameters

- `worksheetId` integer, required

## Query parameters

- `pageNumber` integer
- `pageSize` integer

## Headers

- `Customer-Id` integer, required

## Response `200`

OK

- ReadWorksheetQuestionModel — Represents a model that holds information about a worksheet question
  - `id` integer — The unique identifier of the worksheet question
  - `questionText` string — The title associated with the given question
  - `order` integer — The order of the question in the worksheet
  - `type` 'boolean' | 'numberInteger' | 'numberDecimal' | 'text' | 'listMulti' | 'signature' | 'statement' | 'cost' | 'date' | 'photo' | 'time' | 'listSingle' | 'barcode' | 'appLaunch' | 'listIconSingle' | 'listIconMulti' | 'ocr' | 'file' | 'Unknown' — Enumeration representing different types of worksheet questions<p>Possible values:</p><ul><li><b>boolean</b>: Used for Yes/No worksheet Question types</li><li><b>numberInteger</b>: Used for Whole Number worksheet question types which allow the user to provide a whole number without a decimal place</li><li><b>numberDecimal</b>: Used for Decimal worksheet question types. Responses contain a number with a decimal place</li><li><b>text</b>: Used for Text worksheet question types</li><li><b>listMulti</b>: Used for worksheet type of List when the multiple answer setting is set to yes. Responses contain multiple items from a list defined on the worksheet question</li><li><b>signature</b>: Used for Signature worksheet question types. When used, a name and signature box will be presented for the user to complete</li><li><b>statement</b>: Used for statement worksheet question types. This presents a text-based statement which may be presented to the resource or the customer</li><li><b>cost</b>: Used for Cost question types. This allow a response including a description and an amount</li><li><b>date</b>: Used for worksheet questions with a type of Date</li><li><b>photo</b>: Used for photo worksheet question types. It requires the user to upload a photo or multiple photos</li><li><b>time</b>: Used for worksheet questions with the type of Time in the format of HH:MM</li><li><b>listSingle</b>: Used for worksheet type of List when the multiple answer setting is set to no. Responses contain multiple items from a list defined on the worksheet question</li><li><b>barcode</b>: Used for barcode worksheet questions. This stores the text contained within a barcode and may be scanned in via a device</li><li><b>appLaunch</b>: Used for worksheet questions with a type of Launch App. When used, a separate application specified in the worksheet question will be launched</li><li><b>listIconSingle</b>: Used for worksheet question type of Icon where the multiple answer setting is set to no. Responses contain multiple names or icons defined on the worksheet question</li><li><b>listIconMulti</b>: Used for worksheet question type of Icon where the multiple answer setting is set to yes. Responses contain multiple names or icons defined on the worksheet question</li><li><b>ocr</b>: Used for worksheet question with a type of OCR</li><li><b>file</b>: Used for worksheet question type of View File</li><li><b>unknown</b>: Represents an unknown worksheet question type</li></ul>
  - `isMandatory` boolean — Indicates whether the answer to the worksheet question is mandatory
  - `defaultRawAnswerText` string, nullable — Default answer text for a given question
  - `maxLength` integer, nullable — The maximum length allowed for the answer for a question of type Text
  - `validItems` string[], nullable — A list of valid items that can be selected or entered as answers for a question of type ListSingle, ListMulti, ListIconSingle, or ListIconMulti

## Other responses

- `404` — Not Found
- `422` — Unprocessable Content

---

[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)