---
title: "Get a list of job worksheets"
method: GET
path: "/v1/jobs/{jobId}/worksheets"
tags: ["Jobs"]
---

# Get a list of job worksheets

`GET /v1/jobs/{jobId}/worksheets`

Retrieve a paged collection of worksheets for a given job (required scope jobs:read)

## Path parameters

- `jobId` integer, required

## Query parameters

- `pageNumber` integer
- `pageSize` integer
- `includeBranchedWorksheets` boolean

## Headers

- `Customer-Id` integer, required

## Response `200`

OK

- PagedResponseReadJobWorksheetModel — A paged collection of items
  - `items` ReadJobWorksheetModel[] — The items returned for the requested page
    - `id` integer — The unique identifier for the worksheet associated with the job
    - `name` string — The name of the worksheet associated with the job
    - `linkType` 'linkedToJob' | 'branchedFromWorksheetQuestion' — The type of link the worksheet has to the job. Worksheet question can have conditional branching which allows different worksheets to be linked based on answers given.<p>Possible values:</p><ul><li><b>linkedToJob</b>: The worksheet is linked directly to the job</li><li><b>branchedFromWorksheetQuestion</b>: The worksheet is branched from a worksheet question</li></ul>
  - `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
- `404` — Not Found
- `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)