---
title: "Get Dashboard Service Request Setup"
method: GET
path: "/dashboardsettings/requestsetup/{setupId}"
tags: ["DashboardSettings"]
---

# Get Dashboard Service Request Setup

`GET /dashboardsettings/requestsetup/{setupId}`

## Request

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

Returns a Service Request Setup for Dashboard

## Path parameters

- `setupId` integer, required

## Response `200`

Indicates that the request succeeded

- ServiceChannelServicesMessagingDashboardSettingsSetupRequestResponse
  - `SetupId` integer: Store Dashboard Setup ID.
  - `EnableRequestWizard` boolean: This flag enables/disables request wizard for the dashboard.
  - `ShowPrivateStoreNotes` boolean: Show/hide private store notes in the 'location notes' field on the first step of the service request wizard page.
  - `ShowProviderPhoneNumber` boolean: Show/hide provider phone number on the confirmation step after an issue has been submitted.
  - `ShowLastServiceCall` boolean: Show last service call and last description in the body of alert email.
  - `SetOriginalVendorForRecalls` boolean: This option controls whether original vendor is assigned to the work order in case of a recall.
  - `NteToZeroForRecalls` boolean: Set NTE to zero if a new service request is marked as a recall.
  - `SendAlertToFM` boolean: This flag controls whether service request email will be sent to the facility managers or not.
  - `TurnOffDescription` boolean: Show/hide problem description field.
  - `DaysOfHistoryToDisplay` integer: How many days of work order history to display on the dublicates warning report.
  - `ShowStoreWarrantyStr` string: There are three possible options: 1) 'none' hides a StoreWarrantyMessage on the first step of the Request Wizard; 2) 'show' shows a StoreWarrantyMessage on the first step of the Request Wizard; 3) 'stop' shows a StoreWarrantyMessage without a possibility to move to the next step.
  - `StoreWarrantyMessage` string: A store warranty message to show on the first step of the request wizard page.
  - `ConfirmationMessage` string: This message is shown on the confirmation page after the user submits their request.
  - `ProviderNotFoundMessage` string: An error message to show when provider is not found for the specified issue choice.
  - `EnableEquipment` boolean: Show equipment
  - `DuplicateFilters` string[]
  - `ExcludedCategoriesOpenDup` string[]
  - `ExcludedCategoriesClosedDup` string[]
  - `ExcludedStatuses` string[]
  - `ExcludedTradesOpenDup` string[]
  - `EnableEquipmentReplacementFlag` boolean
  - `EnableRequestWizardMobile` boolean: This flag enables/disables request wizard for the SC Mobile.
  - `EnableLocationNotes` boolean
  - `AlwaysShowLocationNotes` boolean
  - `SkipTroubleshootingStep` boolean
  - `HidePriority` boolean
  - `EnableIssueListKeywordSearch` boolean: This flag enables/disables the keyword search functionality on the request wizard. When enabled, users can type keywords to more quickly identify issue list selections.
  - `HideGPSRadius` boolean
  - `AssetFirstWorkOrderCreation` boolean: Enables asset-first approach for work order creation.
  - `EnableEquipmentReplacement` boolean
  - `AssetNotListedFlag` 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)