Sign in

v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Locations

Create a company location

Create a company location, which represents any address 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:write

post/v1/companies/{company_id}/locations

Path parameters

company_idstring required

The UUID of the company

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.

Request body

street_1string required

Street address line 1.

street_2string nullable

Street address line 2.

citystring required

City.

statestring required

State code (e.g. CA). Must be a valid two-letter state code.

zipstring required

ZIP code. Must be a valid US zip (e.g. 12345 or 12345-6789).

countrystring

Country code. Defaults to USA.

phone_numberstring required

Phone number. Must be 10 digits.

mailing_addressboolean

Specify if this location is the company's mailing address.

filing_addressboolean

Specify if this location is the company's filing address.

Example request

{
  "street_1": "300 3rd Street",
  "street_2": "Apartment 318",
  "city": "San Francisco",
  "state": "CA",
  "zip": "94107",
  "country": "USA",
  "phone_number": "8009360383"
}

Response

Created

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.