TriNet

App · 20 actions

Read employees, company configuration, departments, locations, benefit plans and payroll schedules.

Actions

ActionWhat it does
Get companyGet company.
Get departmentGet department.
Get locationGet location.
Get paygroupGet paygroup.
List benefit classesList benefit classes.
List benefitsList benefits.
List company custom fieldsList company custom fields.
List departmentsList departments.
List employee changesList employee changes.
List employeesList employees.
List holidaysList holidays.
List jobsList jobs.
List leave plansList leave plans.
List locationsList locations.
List pay codesList pay codes.
List paygroupsList paygroups.
List payroll schedulesList payroll schedules.
List savings plansList savings plans.
List supervisorsList supervisors.
List workers comp codesList workers comp codes.

Get company

Get company.

Inputs

View typeview_typetext
when set to "all" allows provides additional detailsOne of: Basic, All, Custom.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "_requestId": "example",
    "_statusCode": "example",
    "_statusMessage": "example",
    "_statusText": "example",
    "data": {
      "companyId": "example",
      "companyName": "example",
      "legalName": "example",
      "liveDate": "example",
      "parentClientId": "example"
    }
  }
}

Get department

Get department.

Inputs

Department IDdepartment_idtextRequired
Find results based on department Id
Effective dateeffective_datedate
Provides information as of date. Allows retrieving historical information. YYYY-MM-DD format.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "_requestId": "example",
    "_statusCode": "example",
    "_statusMessage": "example",
    "_statusText": "example",
    "data": []
  }
}

Get location

Get location.

Inputs

Location IDlocation_idtextRequired
Filters locations based on location id
Effective dateeffective_datedate
Provides information as of date. Allows retrieving historical information. YYYY-MM-DD format.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "_requestId": "example",
    "_statusCode": "example",
    "_statusMessage": "example",
    "_statusText": "example",
    "data": []
  }
}

Get paygroup

Get paygroup.

Inputs

Paygroup IDpaygroup_idtextRequired
Filter results by Pay Group ID
Effective dateeffective_datedate
Provides information as of date. Allows retrieving historical information. YYYY-MM-DD format.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "_requestId": "example",
    "_statusCode": "example",
    "_statusMessage": "example",
    "_statusText": "example",
    "data": {
      "effectiveDate": "example",
      "payFrequency": "example",
      "payGroupDescription": "example",
      "payGroupId": "example",
      "payGroupShortName": "example"
    }
  }
}

List benefit classes

List benefit classes.

Inputs

Efft dateefft_datedate
Provides information as of date. Allows retrieving historical information. YYYY-MM-DD format.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "_requestId": "example",
    "_statusCode": "example",
    "_statusMessage": "example",
    "_statusText": "example",
    "data": []
  }
}

List benefits

List benefits.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "_requestId": "example",
    "_statusCode": "example",
    "_statusMessage": "example",
    "_statusText": "example",
    "data": []
  }
}

List company custom fields

List company custom fields.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "_error": {
      "detailMessage": {},
      "errorCode": "example",
      "field": "example",
      "message": "example",
      "moreInfo": "example"
    },
    "_requestId": "example",
    "_statusCode": "example",
    "_statusMessage": "example",
    "_statusText": "example",
    "data": []
  }
}

List departments

List departments.

Inputs

Dept namedept_nametext
Filters results based on department name
Dept codedept_codetext
Filters results based on department code
Effective dateeffective_datedate
Provides information as of date. Allows retrieving historical information. YYYY-MM-DD format.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "_requestId": "example",
    "_statusCode": "example",
    "_statusMessage": "example",
    "_statusText": "example",
    "data": []
  }
}

List employee changes

List employee changes.

Inputs

Eventseventstext
Comma delimited list of events to filter the returned data for.
From datefrom_datedate
Date that the changes should be reported from. Required format, YYYY-MM-DDTHH:MM:SS.999Z
To dateto_datedate
Date that the changes should be reported to. If empty current will report to current time. Required format, YYYY-MM-DDTHH:MM:SS.999Z

Outputs

dataobject
Response.
Example output
{
  "data": {
    "_requestId": "example",
    "_statusCode": "example",
    "_statusMessage": "example",
    "_statusText": "example",
    "data": []
  }
}

List employees

List employees.

Inputs

Employee IDemployee_idtext
Returns the requested employee information for a specified Employee ID.
Alternate IDalternate_idtext
Returns the requested employee information for a specified Alternate ID.
Employment statusemployment_statustext
Filters results by Employment Status.
Last namelast_nametext
Filters results by employee's last name. Wild characters are allowed. Example. "?lastName=Smit*"
First namefirst_nametext
Filters results by employee's first name. Wild characters are allowed. Example. "?firstName=Joh*"
Department IDdepartment_idtext
Lists employees assigned to a specified Department ID.
Location IDlocation_idtext
Lists employees assigned to a specified Location ID.
Supervisor IDsupervisor_idtext
Lists employees assigned to a specified supervisor. You must provide the supervisor’s Employee ID.
View typeview_typetext
Controls what data is returned for each employee. Options are Basic, All or Custom. If not specified, then it will return Basic information. To use Custom, specify the sections in fieldMask. Required scopes differ based on the view type; Basic view requires basic-read scope while All and Custom require hr-pay-readOne of: Basic, All, Custom.
Limitlimitnumber
Specify the number of returned records to control the data size. By default it displays the maximum of 100 employees.
Offsetoffsetnumber
Specify the starting record. This limits the returned data to 100 employees. If there are more than 100 employees, you will need to make subsequent calls. Example. Set the offset to 101 to return employees 101-200. The "hasMore" flag in the response indicates that the end of the range has been reached.
Field maskfield_masktext
Required when viewType=Custom. Specify which sections to include or exclude from the results. To exclude add "-" as the first character. Examples. "?viewType=Custom&fieldMask=names,roles" returns the emloyeeId, alternateId, names and roles sections. "?viewType=Custom&fieldMask=-names,roles" returns all employee data from the All view, except the names and roles sections.
Sort ordersort_ordertext
Sorts the data based on a predefined list of fields. employeeId, alternateId, lastName, firstName, departmentId, locationId. Allows sorting on multiple fields. To use descending order, add "desc" to the query. Example. "?sortOrder=lastName desc, firstName" will sort results by lastName in descending order, then firstName in ascending order.
Has roleshas_rolestext
Lists employees has at least one role. You must provide the yes

Outputs

dataobject
Response.
Example output
{
  "data": {
    "_requestId": "example",
    "_statusCode": "example",
    "_statusMessage": "example",
    "_statusText": "example",
    "data": {
      "employeeData": [],
      "employeesTotal": 1,
      "hasMore": false
    }
  }
}

List holidays

List holidays.

Inputs

Date limitdate_limittext
Provides information as of date. Allows retrieving historical information. YYYY-MM-DD format.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "_requestId": "example",
    "_statusCode": "example",
    "_statusMessage": "example",
    "_statusText": "example",
    "data": {
      "companyHolidayDetails": []
    }
  }
}

List jobs

List jobs.

Inputs

Job IDjob_idtext
Filter results to given Job ID

Outputs

dataobject
Response.
Example output
{
  "data": {
    "_requestId": "example",
    "_statusCode": "example",
    "_statusMessage": "example",
    "_statusText": "example",
    "data": []
  }
}

List leave plans

List leave plans.

Inputs

Effective dateeffective_datedate
Provides information as of date. Allows retrieving historical information. YYYY-MM-DD format.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "_requestId": "example",
    "_statusCode": "example",
    "_statusMessage": "example",
    "_statusText": "example",
    "data": []
  }
}

List locations

List locations.

Inputs

Location namelocation_nametext
Filters locations based on location name
State codestate_codetext
Filters locations by state code
Headquarterheadquartertrue/false
Lists only headquarter
Effective dateeffective_datedate
Provides information as of date. Allows retrieving historical information. YYYY-MM-DD format.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "_requestId": "example",
    "_statusCode": "example",
    "_statusMessage": "example",
    "_statusText": "example",
    "data": []
  }
}

List pay codes

List pay codes.

Inputs

Typetypetext
Filter results based on pay type

Outputs

dataobject
Response.
Example output
{
  "data": {
    "_requestId": "example",
    "_statusCode": "example",
    "_statusMessage": "example",
    "_statusText": "example",
    "data": []
  }
}

List paygroups

List paygroups.

Inputs

Effective dateeffective_datedate
Provides information as of date. Allows retrieving historical information. YYYY-MM-DD format.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "_requestId": "example",
    "_statusCode": "example",
    "_statusMessage": "example",
    "_statusText": "example",
    "data": []
  }
}

List payroll schedules

List payroll schedules.

Inputs

Start datestart_datedate
startDate can be used to limit the data returned by API. If not provided all data is returned. If provided endDate has to be provided as well. Format, YYYY-MM-DD can be used to limit the data returned by API. Start date is applied to payrollPreparationDate and is in YYYY-MM-DD format
End dateend_datedate
endDate can be used to limit the data returned by API. If not provided all data is returned. If provided startDate has to be provided as well. Format, YYYY-MM-DD can be used to limit the data returned by API. Start date is required if endDate provided. Applied to payrollPreparationDate and is in YYYY-MM-DD format

Outputs

dataobject
Response.
Example output
{
  "data": {
    "_requestId": "example",
    "_statusCode": "example",
    "_statusMessage": "example",
    "_statusText": "example",
    "data": []
  }
}

List savings plans

List savings plans.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "_requestId": "example",
    "_statusCode": "example",
    "_statusMessage": "example",
    "_statusText": "example",
    "data": []
  }
}

List supervisors

List supervisors.

Inputs

None.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "_requestId": "example",
    "_statusCode": "example",
    "_statusMessage": "example",
    "_statusText": "example",
    "data": []
  }
}

List workers comp codes

List workers comp codes.

Inputs

Statestatetext
Filter results based on State
Work comp codework_comp_codetext
Filter results based on Workers Comp Code

Outputs

dataobject
Response.
Example output
{
  "data": {
    "_requestId": "example",
    "_statusCode": "example",
    "_statusMessage": "example",
    "_statusText": "example",
    "data": []
  }
}

On this page