---
title: "Get an attachment"
method: GET
path: "/v1/attachments/{attachmentId}"
tags: ["Attachments"]
---

# Get an attachment

`GET /v1/attachments/{attachmentId}`

## Request

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

Retrieves a single attachment, including its download URL (required scope attachments:read)

## Path parameters

- `attachmentId` integer, required

## Headers

- `Customer-Id` integer, required

## Response `200`

OK

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

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

## Changes

- **2026-10-14** `6d14f46623c8`: 2 breaking, 2 warning, 1 info
  - added `#/components/schemas/ReadAttachmentModel, #/components/schemas/ReadAttachmentModelWithFolderId` to the response body `oneOf` list for the response status `200`
  - the response's body type changed from `object` to no type for status `200`
  - removed the optional property `thumbnailUrl` from the response with the `200` status
  - removed the optional property `url` from the response with the `200` status
  - …1 more
- **2026-09-30** `45b05fe73cc9`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/bigchange/apis/bigchange-dx/changes/v1/attachments/:attachmentId/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)