Sign in

v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Locations

Get a location

Get a location.

scope: companies:read

get/v1/locations/{location_id}

Path parameters

location_idstring required

The UUID of the location

Headers

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Response

successful

uuidstring required

The UUID of the location object.

versionstring

The current version of the object. See the versioning guide for information on how to use this field.

company_uuidstring

The UUID for the company to which the location belongs. Only included if the location belongs to a company.

phone_numberstring

The phone number for the location. Required for company locations. Optional for employee locations.

street_1string
street_2string nullable
citystring
statestring
zipstring
countrystring
mailing_addressboolean

Specifies if the location is the company's mailing address. Only included if the location belongs to a company.

filing_addressboolean

Specifies if the location is the company's filing address. Only included if the location belongs to a company.

created_atstring

Datetime for when location is created

updated_atstring

Datetime for when location is updated

activeboolean

The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.

inactiveboolean

The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.