---
title: "Get Dashboard Note Setup"
method: GET
path: "/dashboardsettings/notesetup/{setupId}"
tags: ["DashboardSettings"]
---

# Get Dashboard Note Setup

`GET /dashboardsettings/notesetup/{setupId}`

## Request

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

Returns a Note Setup for Dashboard

## Path parameters

- `setupId` integer, required

## Response `200`

Indicates that the request succeeded

- ServiceChannelServicesMessagingDashboardSettingsSetupNoteResponse: Settings for Dashboard Notes
  - `SetupId` integer: Store Dashboard Setup ID.
  - `AllowAddingNotes` boolean: Enable / disable an ability to add workorder notes.
  - `AllowAddingNotesForCompletedWorkorders` boolean: Enable / disable an ability to add notes for workorders with status "completed".
  - `MaskMoney` boolean: Parse a work order description and a note text in order to mask money.
  - `MaskPhone` boolean: Parse a work order description and a note text in order to mask phone numbers.
  - `MaskEmail` boolean: Parse a work order description and a note text in order to mask email.
  - `ShowProviderRecipients` boolean: Show provider recipients as wo note recipients.
  - `ShowSubscriberRecipients` boolean: Show subscriber recipients as wo note recipients.
  - `ShowPublicUserEmailsOnly` boolean: Show only users with public emails as wo note recipients.
  - `ShowUniversalRecipients` boolean: Show universal users as wo note recipients.
  - `LocationNotesAsRecipients` string: Show emails from location notes as wo note recipients.
  - `AutoCopyContractorNotes` boolean: Specify custom addressees to show as wo note recipients.
  - `ActionRequiredSelectProviderEmail` boolean: Automatically select provider assigned to WO as email recipient on WO note emails when ‘Action Required’ is selected.
  - `CustomNoteRecipients` string: Specify custom addressees to show as wo note recipients.
  - `Statuses` string[]
  - `DisableNotes` boolean
  - `NoteEmails` string[]: Get addresses without dublicates.
  - `AllowResolvingActionRequiredNotes` boolean

## Other responses

- `401`: Indicates that the requested resource requires authentication. <br>Error codes: 504 - API call rejected by security permissions;
- `403`: Access denied. <br>Error codes: 1000 - The setupId does not belong to the Subscriber;
- `404`: Indicates that the requested resource does not exist on the server.
- `500`: The server was unable to complete the request due to an internal error. <br/>Error codes: 501 - Unspecified internal server error occurred

---

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