v1

latestOpenAPI 3.1.02026-07-243113441.2 MB

Employee Addresses

Create an employee's home address

The home address of an employee is used to determine certain tax information about them. Addresses are geocoded on create and update to ensure validity.

Supports home address effective dating and courtesy withholding.

scope: employees:write

post/v1/employees/{employee_id}/home_addresses

Path parameters

employee_idstring required

The UUID of the employee

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

street_2string nullable

citystring

statestring

zipstring

effective_datestring date nullable

courtesy_withholdingboolean

Example request

{
  "street_1": "300 3rd Street",
  "city": "San Francisco",
  "state": "CA",
  "zip": "94107",
  "effective_date": "2022-01-31"
}

Response

created

uuidstring required

The UUID of the employee address

employee_uuidstring

The UUID of the employee

effective_datestring date

The date the employee started living at the address.

courtesy_withholdingboolean

Determines if home taxes should be withheld and paid for employee.

street_1string

street_2string nullable

citystring

statestring

zipstring

countrystring

activeboolean

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

versionstring required

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