---
title: "Retrieve a work request"
method: GET
path: "/workrequests/{id}"
tags: ["WorkRequests"]
---

# Retrieve a work request

`GET /workrequests/{id}`

## Request

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

*In limited availability phase.*

## Path parameters

- `id` integer, required

## Response `200`

Indicates that the request succeeded and that the requested information is in the response.

- ServiceChannelServicesMessagingWorkRequestsWorkRequest: Work Request
  - `Id` integer: Id
  - `SubscriberId` integer: Subscriber Id
  - `SubscriberShortName` string: Subscriber Short Name
  - `ProviderId` integer: Provider Id
  - `ProviderShortName` string: Provider Short Name
  - `LocationId` integer: Location Id
  - `LocationStoreId` string: Location Store Id
  - `EventId` string: Event Id
  - `StatusId` integer: Status Id
  - `StatusName` string: Status Name
  - `ExtendedStatusId` integer: Extended Status Id
  - `ExtendedStatusName` string: Extended Status Name
  - `ClosedReasonId` integer: Closed Reason Id
  - `ClosedReasonName` string: Closed Reason Name
  - `Description` string: Description
  - `TradeId` integer: Trade Id
  - `TradeName` string: Trade Name
  - `CategoryId` integer: Category Id
  - `CategoryName` string: Category Name
  - `PriorityId` integer: Priority Id
  - `PriorityName` string: Priority Name
  - `Caller` string: Caller
  - `CallDate` string, date-time: Call Date
  - `ClosedDate` string, date-time: Closed Date
  - `ScheduledDate` string, date-time: Scheduled Date
  - `WorkOrderId` integer: Work Order Id
  - `AssetId` integer: Asset Id
  - `Nte` ServiceChannelServicesMessagingWorkRequestsWorkRequestNte: Work Request Nte
    - `Value` number, double: Value
    - `CurrencyId` integer: Currency Id
    - `CurrencyAlphabeticCode` string: Currency Alphabetic Code
  - `Issue` ServiceChannelServicesMessagingWorkRequestsWorkRequestIssue: Work Request Issue
    - `AreaId` integer: Area Id
    - `AreaName` string: Area Name
    - `ProblemType` string: Problem Type
    - `Equipment` string: Equipment
    - `ProblemCode` string: Problem Code
    - `SetupId` integer: Setup Id

## Other responses

- `401`: 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. <br/>Error codes: 502 — Data not found

---

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