BAbamboohr
Employee Tables
Public API

Get Employee Table Data

Changed on

Returns all rows for a given employee and table combination. The result is not sorted in any particular order. Each row contains the fields defined for that table, subject to field-level permission checks. Fields the caller does not have access to are omitted from the response.

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

get/api/v1/employees/{id}/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
    • or OAuth 2
      Authorization code/authorize.php
      Token URL/token.php
      Scopesemployee:job.write
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

The internal employee ID. Use the special value "all" to retrieve table data for all employees the authenticated caller has access to.

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. See the TableName schema for standard values; custom tables also accepted (e.g., custom1, custom42). Use the list-tabular-fields tool (GET /api/v1/meta/tables) to discover custom table names.

Headers

AcceptHeaderParameter'application/xml' | 'application/json'

This endpoint can produce either JSON or XML.

Response

All rows for the specified employee and table.

idstring

The table row ID.

employeeIdstring

The internal employee ID that owns this row.

Changes

  • 922fc15f43a7Revision changes
    • info

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

    • info

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