v1

latestOpenAPI 3.1.02026-07-243113441.2 MB

Locations

Get all company locations

Retrieves all company locations (addresses) associated with a company: mailing addresses, filing addresses, or work locations. A single address may serve multiple, or all, purposes.

Since all company locations are subsets of locations, use the Locations endpoints to get or update an individual record.

scope: companies:read

get/v1/companies/{company_id}/locations

Path parameters

company_idstring required

The UUID of the company

Query parameters

pageinteger

The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.

perinteger

Number of objects per page. For majority of endpoints will default to 25

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

Success

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.