version-identity-company-employeeId-addresses-get

GET

Personal Address

Retrieve employee address information.

 

{
  "employeeId":"string",
  "addressType":"HOME",
  "effectiveDate":"datetime",
  "address1":"string",
  "address2":"string",
  "address3":"string",
  "address4":"string",
  "city":"string",
  "county":"string",
  "state":"string",
  "postalCode":"string",
  "country":"string",
  "primaryInd":"boolean",
  "uniqueId":"string"
}
Field Description

employeeId

TriNet employee ID

addressType

Type of address, such as Home

effectiveDate

Date the information became effective

Address1

Address line 1

Address2

Address line 2

Address3

Address line 3

Address4

Address line 4

City

City

County

County

State

State or province

postalCode

ZIP or postal code

Country

Country

Values: CA (for Canada), US (for United States)

primaryInd

Whether this is the primary address

uniqueId

TriNet only

Resource URL

https://api.trinet.com /{version}/identity/{company}/{employeeId}/addresses

Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400

  • 401

  • 403

  • 404

Resource Summary

Security:

Scope:

hr-personal-read

Working...