---
title: "Get a list of attachments for a worksheet answer"
method: GET
path: "/v1/worksheetAnswer/{worksheetAnswerId}/attachments"
tags: ["WorksheetAnswer"]
---

# Get a list of attachments for a worksheet answer

`GET /v1/worksheetAnswer/{worksheetAnswerId}/attachments`

## Request

- Base URL: `https://api.bigchange.com`
- URL: `https://api.bigchange.com/v1/worksheetAnswer/{worksheetAnswerId}/attachments`
- Auth: HTTP bearer

Retrieve a paged collection of attachments belonging to a worksheet answer (required scope attachments:read)

## Path parameters

- `worksheetAnswerId` integer, required

## Query parameters

- `fileName` string
- `isResourceVisible` boolean
- `sortBy` 'createdAt': The field to sort attachments by<p>Possible values:</p><ul><li><b>createdAt</b>: Sort by the date the attachment was created</li></ul>
- `direction` 'ascending' | 'descending': Represents the direction in which sorting should be applied<p>Possible values:</p><ul><li><b>ascending</b>: Indicates ascending sorting order</li><li><b>descending</b>: Indicates descending sorting order</li></ul>
- `pageNumber` integer
- `pageSize` integer

## Headers

- `Customer-Id` integer, required

## Response `200`

OK

- PagedResponseReadAttachmentModel: A paged collection of items
  - `items` union[]: The items returned for the requested page
    - union: Represents an attachment, including its download URL
      - ReadAttachmentModel: Represents an attachment
        - `id` integer: The unique identifier of the attachment
        - `fileName` string: The file name of the attachment
        - `fileDescription` string, nullable: The description of the attachment
        - `fileType` string: The MIME type of the attachment file
        - `fileExtension` string: The file extension of the attachment
        - `isNew` boolean: Whether the attachment has not yet been viewed
        - `isImage` boolean: Whether the attachment file is an image
        - `createdAt` string, date-time: The UTC timestamp of when this attachment was created
        - `entityType` 'job' | 'worksheetAnswer' | 'contactNote' | 'invoice' | 'contact' | 'jobGroup' | 'salesOpportunity' | 'invoiceAttachment': The type of entity an attachment is associated with<p>Possible values:</p><ul><li><b>job</b>: Associated with a job entity</li><li><b>worksheetAnswer</b>: Associated with a worksheet answer entity</li><li><b>contactNote</b>: Associated with a contact note entity</li><li><b>invoice</b>: Associated with an invoice entity</li><li><b>contact</b>: Associated with a contact entity</li><li><b>jobGroup</b>: Associated with a job group entity</li><li><b>salesOpportunity</b>: Associated with a sales opportunity entity</li><li><b>invoiceAttachment</b>: Associated with an invoice attachment entity</li></ul>
        - `isResourceVisible` boolean: Whether the attachment is visible to a resource (mobile field engineer)
      - ReadAttachmentModelWithFolderId: Represents an attachment
        - `id` integer: The unique identifier of the attachment
        - `fileName` string: The file name of the attachment
        - `fileDescription` string, nullable: The description of the attachment
        - `fileType` string: The MIME type of the attachment file
        - `fileExtension` string: The file extension of the attachment
        - `isNew` boolean: Whether the attachment has not yet been viewed
        - `isImage` boolean: Whether the attachment file is an image
        - `createdAt` string, date-time: The UTC timestamp of when this attachment was created
        - `entityType` 'job' | 'worksheetAnswer' | 'contactNote' | 'invoice' | 'contact' | 'jobGroup' | 'salesOpportunity' | 'invoiceAttachment': The type of entity an attachment is associated with<p>Possible values:</p><ul><li><b>job</b>: Associated with a job entity</li><li><b>worksheetAnswer</b>: Associated with a worksheet answer entity</li><li><b>contactNote</b>: Associated with a contact note entity</li><li><b>invoice</b>: Associated with an invoice entity</li><li><b>contact</b>: Associated with a contact entity</li><li><b>jobGroup</b>: Associated with a job group entity</li><li><b>salesOpportunity</b>: Associated with a sales opportunity entity</li><li><b>invoiceAttachment</b>: Associated with an invoice attachment entity</li></ul>
        - `isResourceVisible` boolean: Whether the attachment is visible to a resource (mobile field engineer)
  - `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
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

## Changes

- **2026-10-22** `e91e0c534929`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/bigchange/apis/bigchange-dx/changes/v1/worksheetAnswer/:worksheetAnswerId/attachments/get.md)

---

[API](https://skmtc.dev/bigchange/apis/bigchange-dx.md) - [All operations](https://skmtc.dev/bigchange/apis/bigchange-dx/llms.txt) - [OpenAPI document](https://skmtc.dev/bigchange/apis/bigchange-dx/revisions/b262bfdb1dd0?raw)