---
title: "Note email recipients"
method: GET
path: "/workorders/{workorderId}/notes/recipients"
tags: ["Notes"]
---

# Note email recipients

`GET /workorders/{workorderId}/notes/recipients`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/workorders/{workorderId}/notes/recipients`
- 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/workorders/:workorderId/notes/recipients/get.ts> (a function with typed inputs; its response is checked against the schema)

List of email recipients, who can be added to the list of note followers

## Path parameters

- `workorderId` integer, required

## Query parameters

- `showExcluded` boolean
- `noteVisibility` 'VisibleToEveryone' | 'VisibleToProvider' | 'VisibleToClient' | 'NotVisible'

## Response `200`

Request succeeded and the requested information is in the response.

- ServiceChannelServicesMessagingNotesEmailRecipientResponse[]
  - `Id` integer: The unique numeric identifier of the user who can be added to the list of email notification recipients.
  - `UserName` string: The username of the email notification recipient.
  - `Email` string: The email address of the notification recipient.
  - `RecipientType` 'Undefined' | 'RegularRecipient' | 'Provider' | 'Follower' | 'LocationNoteRecipient': Defines the type of the email notification recipient.

## Other responses

- `400`: Bad Request - the request could not be understood or was missing required parameters. <br/>Error codes: <br/> 917 - Invalid work order identifier. Returned if workorderId is &lt;= 0;
- `401`: Unauthorized indicates that the requested resource requires authentication. <br/>Error codes: <br/> 504 - API call rejected by security permissions;
- `404`: The requested resource does not exist on the server.

---

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