v1

latestOpenAPI 3.1.02026-07-243113441.2 MB

Employee Addresses

Create an employee work address

The work address of an employee describes when an employee began working at an associated company location.

scope: employees:manage

post/v1/employees/{employee_id}/work_addresses

employee_idstring required

The UUID of the employee

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.

location_uuidstring

Reference to a company location

effective_datestring date

Date the employee began working at the company location

{
  "location_uuid": "6a119be7-b4b0-4e27-aaa0-89d5f2524635",
  "effective_date": "2023-05-15"
}

created

uuidstring required

The unique identifier of this work address.

effective_datestring

The date the employee began working at this location.

activeboolean

Signifies if this address is the active work address for the current date

location_uuidstring

UUID reference to the company location for this work address.

employee_uuidstring

UUID reference to the employee for this work address.

versionstring required

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

street_1string

street_2string nullable

citystring

statestring

zipstring

countrystring