Sign in

v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Employee Tables
Public API

Create Table Row (v1)

Deprecated. Use Create Table Row (v1.1) instead (create-table-row-v1-1). Add a new row to the specified employee table by submitting field name/value pairs in JSON or XML. Use this endpoint to append records to tabular employee data such as job information or compensation history.

OAuth Scopes: employee, employee.write, employee:assets.write, employee:compensation.write, employee:custom_fields.write, employee:custom_fields_encrypted.write, employee:education.write, employee:emergency_contacts.write, employee:job, employee:job.write, sensitive_employee:creditcards.write

post/api/v1/employees/{id}/tables/{table}

Path parameters

idstring required

The employee ID.

tablestring required

The API name of an employee table. Standard table names: jobInfo, jobInformation, compensation, employmentStatus, contacts, emergencyContacts, dependents, earnings, bonus, commission, benefit_class, employeeVisas, employeeEducation, employeePassports, employeeDriverLicenses, employeeCertifications, employeeStockOptions, employeeAssets, employeeCreditCards, employeeCovidTests, employeeCovidVaccinations, employeeCovidVaccinationExemptions, employeeCovidExposures, employeeEquityGrants, levelsAndBands, employeeProjectPayRates. Custom company-defined tables also accepted — they use a numeric suffix (e.g., custom1, custom42). Use the list-tabular-fields tool (GET /api/v1/meta/tables) to discover custom table names for a specific company.

Example:employeeEducation

The API name of the table to add a row to. See the TableName schema for valid standard values; custom tables use a custom prefix. Use GET /api/v1/meta/tables to discover the complete list.

Request body

datestring date

The effective date for the row in YYYY-MM-DD format.

locationstring

The employee location value for the row.

divisionstring

The division value for the row.

departmentstring

The department value for the row.

jobTitlestring

The job title value for the row.

reportsTostring

The manager or reports-to value for the row.

teamsstring[]

Team values associated with the row.

Response

Row added successfully. No response body is returned.