---
title: "Retrieve a GPS radius for a work order"
method: GET
path: "/workorders/{workorderId}/GPSRadius"
tags: ["WorkOrders"]
---

# Retrieve a GPS radius for a work order

`GET /workorders/{workorderId}/GPSRadius`

## Request

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

Returns the geolocation radius of the location for the specified work order.  
            <br />The GPS radius is calculated based on [Site Access rules](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/1466435001/Site+Access). If the rules are not set up, the default GPS radius is 2 miles.

## Path parameters

- `workorderId` integer, required

## Response `200`

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

- ServiceChannelServicesMessagingWorkordersGetGPSRadiusResponse: GPS radius object.
  - `WorkorderId` integer: Unique numeric identifier of the work order.
  - `LocationID` integer: Unique numeric identifier of the location.
  - `LocLatitude` number, double: Location latitude, for example, 40.6107492.
  - `LocLongitude` number, double: Location longitude, for example, -73.9539362.
  - `GPSRadius` number, double: Distance around a facility within which a technician is considered to be on-site, for example, 3 miles.

## Other responses

- `400`: The request was not accepted due to bad syntax, missing parameters, insufficient data, etc. <br/>Error codes: 502 — Work order was not found 917 — Invalid tracking number
- `401`: The requested resource requires authentication. Error codes: <br/> 504 - 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)