---
title: "Get WorkRequest Attachments"
method: GET
path: "/workrequest/{workRequestId}/attachments"
tags: ["Attachments"]
---

# Get WorkRequest Attachments

`GET /workrequest/{workRequestId}/attachments`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/workrequest/{workRequestId}/attachments`
- Auth: OAuth 2
  - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize`
  - Token URL: `https://sb2login.servicechannel.com/oauth/token`
- TypeScript: <https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/workrequest/:workRequestId/attachments/get.ts> (a function with typed inputs; its response is checked against the schema)

*In limited availability phase.*

## Path parameters

- `workRequestId` integer, required

## Response `200`

Request succeeded and the requested information is in the response.

- ServiceChannelServicesMessagingAttachmentsAttachment[]
  - `Id` integer: Unique numeric identifier of the attachment.
  - `Description` string: Optional text that a user added when uploading the attachment. The maximum character count is 200.
  - `Name` string: Attachment name.
  - `TimeStamp` string, date-time: Date and time when the attachment was uploaded. The format is `YYYY-MM-DDThh:mm:ss.sss±hh:mm`, where `±hh:mm` represents the time zone offset from UTC.
  - `Uri` string: Link address to the attachment in the ServiceChannel system.
  - `NoteId` integer: Unique numeric identifier of the note to which a user added the attachment.
  - `Visibility` integer: Visibility status of the attachment. Defines which parties can view the attachment. The *PrivateProviderNotesAndAttachments* feature should be enabled. For subscribers who are using Universal Connector, the *PrivateClientNotesAndAttachments* feature should be enabled. <br />Possible values: • `0`: No restrictions on visibility. Visible to everyone. • `1`: Not visible to the client. The subscriber deselected the “Visible to Client” checkmark when uploading an attachment or adding a note with an attachment. • `2`: Not visible to the provider. The subscriber deselected the “Visible to Provider” checkmark when uploading an attachment or adding a note with an attachment. • `3`: Visible to the subscriber only. The subscriber deselected the “Visible to Client” and “Visible to Provider” checkmarks when uploading an attachment or adding a note with an attachment.
  - `IsInvoiceDigitalCopy` boolean: Defines if the attachment is a digital copy of the provider’s invoice. According to subscriber configurations, some providers should attach digital copies of invoices. Possible values: • `true`: The attachment is an invoice digital copy. • `false`: The attachment is not an invoice digital copy. <br />***Note:*** Subscribers can set the requirement of a digital invoice copy from providers when the *InvoiceRequireDigitalCopy* feature is turned on.
  - `UploadBy` string: User who uploaded the attachment.

## Other responses

- `401`: Unauthorized indicates that the requested resource requires authentication. <br/>Error codes: <br/> 504 - API call rejected by security permissions;

---

[API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)