---
title: "Retrieve the status of refrigerant use on a work order"
method: GET
path: "/workorders/{workorderId}/refrigerantUseStatus"
tags: ["WorkOrders"]
---

# Retrieve the status of refrigerant use on a work order

`GET /workorders/{workorderId}/refrigerantUseStatus`

## Request

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

Returns the status of refrigerant use on the specified work order:
             • `null`: There is no information on the use of refrigerant.
             • `true`: Refrigerant was used upon execution of the service request.
             • `false`: Refrigerant wasn't used when performing work on the service request.
            <br />Once you try out this method, you can use the `refrigerantWasUsed` value as an input parameter for updating the status of refrigerant use in the [PUT / workorders/{workorderId}/markRefrigerantUse](https://developer.servicechannel.com/swagger/index.html#/WorkOrders/PUTv3_workorders_%7BworkorderId%7D_markRefrigerantUse%3FrefrigerantWasUsed%3D%7BrefrigerantWasUsed%7D%26actor%3D%7Bactor%7D) method or for updating the leak inspection information in the [PUT /workorders/{workOrderId}/UpdateWorkOrderLeakInspectionInfo](https://developer.servicechannel.com/swagger/index.html#/WorkOrders/PUTv3_workorders_%7BworkOrderId%7D_UpdateWorkOrderLeakInspectionInfo%3FrefrigerantWasUsed%3D%7BrefrigerantWasUsed%7D%26leakWasDetected%3D%7BleakWasDetected%7D) method.

## Path parameters

- `workorderId` integer, required

## Response `200`

The status of refrigerant use on the specified work order is in the response.

- boolean

## Other responses

- `401`: The requested resource requires authentication.<br/><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)
