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

# Get a list of worksheet answers

`GET /v1/worksheetAnswers`

Retrieve a paged collection of worksheet answers. At least one of `entityId`, `worksheetId` or `questionId` must be provided (required scope worksheets:read)

## Query parameters

- `questionId` integer[]
- `entityType` 'job' | 'contactNote' | 'stockItem' | 'activityLog' | 'activitySign' | 'assetCheck' — Enumeration representing different types of worksheet answers<p>Possible values:</p><ul><li><b>job</b>: Answer relating to a job entity</li><li><b>contactNote</b>: Answer relating to a contact note entity</li><li><b>stockItem</b>: Answer relating to a stock item entity</li><li><b>activityLog</b>: Answer relating to an activity log entity</li><li><b>activitySign</b>: Answer relating to an activity sign entity</li><li><b>assetCheck</b>: Answer relating to an asset check entity</li></ul>
- `entityId` integer[]
- `worksheetId` integer[]
- `pageNumber` integer
- `pageSize` integer

## Headers

- `Customer-Id` integer, required

## Response `200`

OK

- PagedResponseReadWorksheetAnswerModel — A paged collection of items
  - `items` ReadWorksheetAnswerModel[] — The items returned for the requested page
    - `entityType` 'job' | 'contactNote' | 'stockItem' | 'activityLog' | 'activitySign' | 'assetCheck' — Enumeration representing different types of worksheet answers<p>Possible values:</p><ul><li><b>job</b>: Answer relating to a job entity</li><li><b>contactNote</b>: Answer relating to a contact note entity</li><li><b>stockItem</b>: Answer relating to a stock item entity</li><li><b>activityLog</b>: Answer relating to an activity log entity</li><li><b>activitySign</b>: Answer relating to an activity sign entity</li><li><b>assetCheck</b>: Answer relating to an asset check entity</li></ul>
    - `entityId` integer — The unique identifier of the entity
    - `questionId` integer — The unique identifier of the question
    - `questionText` string — The text body of the question
    - `resourceId` integer, nullable — The unique identifier of the resource
    - `worksheetId` integer — The unique identifier of the worksheet
    - `worksheetName` string, nullable — The name of the worksheet
    - `questionType` '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>
    - `worksheetGroupName` string — The name of the worksheet group
    - `isMandatory` boolean — Is the worksheet answer mandatory
    - `worksheetQuestionOrder` integer — The order of the question in the worksheet
    - `note` string — The note attached to the worksheet answer
    - `rawAnswerText` string — Represents the raw, unparsed text of the worksheet answer
    - `answer` union — The dynamic answer of the worksheet
      - WorksheetAnswerGeneric — Base model wrapper for the answer given to a worksheet question or an empty answer
      - WorksheetAnswerAppLaunch — Base model wrapper for the answer given to a worksheet question or an empty answer
      - WorksheetAnswerBarcode — Base model wrapper for the answer given to a worksheet question or an empty answer
      - WorksheetAnswerBoolean — Base model wrapper for the answer given to a worksheet question or an empty answer
      - WorksheetAnswerCost — Base model wrapper for the answer given to a worksheet question or an empty answer
      - WorksheetAnswerDate — Base model wrapper for the answer given to a worksheet question or an empty answer
      - WorksheetAnswerDecimal — Base model wrapper for the answer given to a worksheet question or an empty answer
      - WorksheetAnswerFile — Base model wrapper for the answer given to a worksheet question or an empty answer
      - WorksheetAnswerInteger — Base model wrapper for the answer given to a worksheet question or an empty answer
      - WorksheetAnswerList — Base model wrapper for the answer given to a worksheet question or an empty answer
      - WorksheetAnswerOCR — Base model wrapper for the answer given to a worksheet question or an empty answer
      - WorksheetAnswerPhoto — Base model wrapper for the answer given to a worksheet question or an empty answer
      - WorksheetAnswerSignature — Base model wrapper for the answer given to a worksheet question or an empty answer
      - WorksheetAnswerStatement — Base model wrapper for the answer given to a worksheet question or an empty answer
      - WorksheetAnswerText — Base model wrapper for the answer given to a worksheet question or an empty answer
      - WorksheetAnswerTime — Base model wrapper for the answer given to a worksheet question or an empty answer
  - `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)