---
title: "Get work order statuses"
method: GET
path: "/workorders/statuses"
tags: ["WorkOrders"]
---

# Get work order statuses

`GET /workorders/statuses`

## Request

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

Returns available work order statuses for the specified subscriber.
            <br />Use the returned ID value as an alternative to the primary status name when updating a status via the [PUT/workorders/{workorderId}/status](https://developer.servicechannel.com/swagger/index.html#/WorkOrders/PUTv3_workorders_%7BworkorderId%7D_status) method.

## Query parameters

- `subscriberId` integer
- `tradeId` integer

## Response `200`

The request succeeded, and the requested information is in response.

- ServiceChannelServicesMessagingWorkordersGetStatusResponse[]
  - `Id` 'NotSet' | 'Open' | 'InProgress' | 'Completed' | 'Incomplete': Unique numeric identifier of the primary work order status. Possible response values: • `0`: NotSet • `1`: Open • `2`: InProgress • `3`: Completed
  - `Name` string: Name of the main status.
  - `Extended` string[]: List of available extended statuses.
  - `ExtendedStatuses` ServiceChannelServicesMessagingWorkordersWorkorderExtendedStatus[]
    - `Id` integer: Unique numeric identifier of the extended status.
    - `Name` string: Name of the extended status.
  - `Constraints` ServiceChannelServicesMessagingWorkordersWorkorderStatusConstraints[]
    - `Extended` string: Name of the extended status.
    - `IsResolutionTextRequired` integer: Indicates whether entering resolution text is required for this status. Returned for providers only. Possible response values: `0`: Not required; `1`: Required.
    - `IsShippingInfoRequired` integer: Indicates whether parts shipping information must be provided: destination, carrier, and shipping tracking number. Returned for providers only. Possible response values: `0`: Not required; `1`: Required.
    - `IsResolutionCodesRequired` integer: Defines whether resolution codes are mandatory. Returned for providers only. Possible response values: `0`: Not required; `1`: Required.
    - `IsScheduledDateRequired` integer: Indicates whether a scheduled date must be set. Returned for providers only. Possible response values: `0`: Not required; `1`: Required.
    - `AskForReviews` boolean: Determines whether the system should prompt the subscriber for a review when the work order enters this status. Returned for subscribers only. Possible values: `true`, `false`.

## Other responses

- `400`: The request was not accepted due to bad syntax, missing parameters, insufficient data, etc.
- `401`: The requested resource requires authentication. <br/>Error codes: 504 &mdash; 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)