BAbamboohr
Change Tracking
Public API

Get Changed Employee Table Data

Changed on

Returns table data for employees that have changed since the given timestamp. This is an optimization to avoid downloading all table data for all employees. It operates on an employee-last-changed-timestamp, which means that a change in ANY field in the employee record will cause ALL of that employee's table rows to show up via this API. The response includes the table rows grouped by employee ID with their last-changed timestamps.

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

get/api/v1/employees/changed/tables/{table}

Request

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

Path parameters

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 to retrieve changed data for. 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.

Query parameters

sincestring date-time required

ISO 8601 timestamp (URL-encoded). Only employees changed since this timestamp will be returned.

Response

Changed table data for the specified table, grouped by employee ID.

tablestring required

The requested table name.

employeesobject required

Map of employee IDs to changed table data for that employee.

Changes

  • 922fc15f43a7Revision changes
    • info

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

    • info

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