BAbamboohr
Employee Tables
Public API

Delete Employee Table Row

Changed on

Deletes a specific row from an employee's tabular data. The table name identifies which tabular dataset to target (e.g., jobInfo, compensation, customTabularField). Returns success: true if the row was deleted, or success: false with an error message if the row was not found or could not be deleted. Deletion will fail with a 409 if the row has pending approval changes or is refused by a table's delete validation rule, or a 412 if the row is tied to an active pay schedule. Per-table field schemas are available as named OpenAPI components (e.g., JobInfoTableRowRequest, CompensationTableRowRequest). See the components/schemas section of this spec for the full list.

OAuth Scopes: 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.write, sensitive_employee:creditcards.write

delete/api/v1/employees/{id}/tables/{table}/{rowId}

Request

  • Base URL
    https://companySubDomain.bamboohr.com
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code/authorize.php
      Token URL/token.php
      Scopesemployee.write
    • or OAuth 2
      Authorization code/authorize.php
      Token URL/token.php
      Scopesemployee:job.write
    • or OAuth 2
      Authorization code/authorize.php
      Token URL/token.php
      Scopesemployee:compensation.write
    • or OAuth 2
      Authorization code/authorize.php
      Token URL/token.php
      Scopesemployee:custom_fields.write
    • or OAuth 2
      Authorization code/authorize.php
      Token URL/token.php
      Scopesemployee:custom_fields_encrypted.write
    • or OAuth 2
      Authorization code/authorize.php
      Token URL/token.php
      Scopesemployee:assets.write
    • or OAuth 2
      Authorization code/authorize.php
      Token URL/token.php
      Scopesemployee:emergency_contacts.write
    • or OAuth 2
      Authorization code/authorize.php
      Token URL/token.php
      Scopessensitive_employee:creditcards.write
    • or OAuth 2
      Authorization code/authorize.php
      Token URL/token.php
      Scopesemployee:education.write
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

The internal employee ID.

tablestring required

The API name of an employee table. Standard table names: jobInfo, compensation, employmentStatus, contacts, emergencyContacts, dependents, earnings, bonus, commission, benefit_class, employeeVisas, employeeEducation, employeePassports, employeeDriverLicenses, employeeCertifications, employeeStockOptions, employeeAssets, employeeCreditCards, employeeCovidTests, employeeCovidVaccinations, employeeCovidVaccinationExemptions, employeeCovidExposures, employeeEquityGrants, 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 containing the row to delete. See the TableName schema for valid standard values; custom tables use a custom prefix (e.g., customTabularField). Use the list-tabular-fields tool (GET /api/v1/meta/tables) to discover the complete list.

rowIdstring required

The ID of the specific row to delete.

Response

Returns success: true if the row was deleted, or success: false with an error message if the row could not be deleted.

successboolean

Whether the row was successfully deleted.

errorstring

Error message when success is false. Absent when success is true.

Changes

  • 922fc15f43a7Revision changes
    • info

      the security scope employee.write was added to the endpoint's security scheme oauth

    • info

      the security scope employee:education.write was removed from the endpoint's security scheme oauth

    • info

      added the non-success response with the status