GuidesAPI ReferenceChangelogAPI PolicyAPI StatusGusto Security
API Reference
These docs are for v2023-09-01. Click to read the latest docs for v2024-04-01.

Get an employee's home addresses

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:read

Path Params
string
required

The UUID of the employee

Headers
string

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

Responses

Response body
array of objects
object
string

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

string
string | null
string
string
string
string
Defaults to USA
boolean

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

string

The UUID of the employee address

string

The UUID of the employee

date

The date the employee started living at the address.

boolean

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

404

Not Found

The requested resource does not exist. Make sure the provided ID/UUID is valid.

Language
Credentials