version-company-company-departments-get

GET

Department

Retrieve information about your company’s departments.

 

{
  "deptId":"string",
  "deptCode":"string",
  "deptName":"string",
  "deptEmployeeCount":"number",
  "deptLocationCount":"number",
  "shortDesc":"string",
  "effectiveDate":"datetime"
}
Field Description

companyId

Unique ID for your company

deptId

Unique ID for the department

deptCode

Department code

deptName

Department name

deptEmployeeCount

Number of employees in the department

deptLocationCount

Number of locations for each department

shortDesc

Department short description

effectiveDate

Date the information became effective

Resource URL

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

Query Parameters


Name Values Description
deptName

Filters results based on department name

deptCode

Filters results based on department code

effectiveDate

Provides information for department 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...