version-company-company-locations-get

GET

Location

Retrieve information about your company’s locations.

 

{
      "locationId":"string",
      "locationName":"string",
      "shortDesc":"string",
      "locationDeptCount": "number",
      "locationEmployeeCount": "number",
      "headquarter":"boolean",
      "effectiveDate":"datetime",
      "phone": "string",
      "officeHours": "string",
      "address":{
        "address1":"string",
        "address2":"string",
        "address3":"string",
        "address4":"string",
        "city":"string",
        "state":"string",
        "postalCode":"string",
        "county":"string",
        "country":"string",
      }
}
Field Description

companyId

Unique ID for your company

locationId

Unique ID for the location

locationName

Location name

shortDesc

Location short description

locationDeptCount

Number of departments in location

locationEmployeeCount

Number of people in location

Headquarter

Whether location is the company headquarters

effectiveDate

Date the information became effective

Phone

Phone number for location

officeHours

Office hours for location

address

 

Address1

Address line 1

Address2

Address line 2

Address3

Address line 3

Address4

Address line 4

City

City

State

State or province

PostalCode

ZIP or postal code

County

County

Country

Country

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

 

Resource URL

https://api.trinet.com /{version}/company/{company}/locations

Query Parameters


Name Values Description
locationName

Filters locations based on location name

stateCode

Filters locations by state code

headquarter

Lists only headquarter

effectiveDate

Provides information for location as of date. Allows retrieving historical information. YYYY-MM-DD format.


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:

basic-read

Working...