Employee data API: Metadata for out-of-the-box employee tables

Two new endpoints in the Employee data API let you discover the schema of Bob’s built-in (out-of-the-box) employee tables, including any custom columns your company has added.

What’s new

• Read metadata of the built-in employee tables (`GET /v1/company/people/employee-tables/metadata`) returns every built-in table that has a data endpoint. For each table you get its id, name, category, whether it’s effective-dated (historical), and all of its columns.
• Read metadata for a specific built-in employee table (`GET /v1/company/people/employee-tables/metadata/{table_id}`) returns the same details for a single table. It returns 404 if the table doesn’t exist or isn’t a built-in employee table.

Good to know

• The table id is the resource name you use to access the table’s data. For example, work is used in /people/{employeeId}/work and /bulk/people/work.
• Custom tables aren’t included. To read those, use the custom tables metadata endpoints.

How does it affect you

• The change is additive and backward compatible, so no action is needed unless you want to use it.
• For request and response details, see:
  • Read metadata of the built-in employee tables
  • Read metadata for a specific built-in employee table.