---
title: "Read metadata for a specific built-in employee table"
method: GET
path: "/company/people/employee-tables/metadata/{table_id}"
tags: ["Metadata"]
---

# Read metadata for a specific built-in employee table

`GET /company/people/employee-tables/metadata/{table_id}`

## Request

- Base URL: `https://api.hibob.com/v1`
- URL: `https://api.hibob.com/v1/company/people/employee-tables/metadata/{table_id}`
- Auth: one of:
  - HTTP basic
  - HTTP bearer

Returns the schema of a single built-in (out-of-the-box) employee table that has a data endpoint. The response includes the table ID, its category, whether it is effective-dated, and all of its columns, including the custom columns added by the company.

To get the table IDs, use `/company/people/employee-tables/metadata`, which lists all the built-in employee tables.

The table `id` is the resource name used in the URL to access the table data, both in the per-employee form and in the bulk form. For example, `work` is used in `/people/{id}/work` and in `/bulk/people/work`, and `equities` is used in `/people/{id}/equities` and in `/bulk/people/equities`.

Custom tables are not included. For those, see `/people/custom-tables/metadata/{custom_table_id}`.

## Path parameters

- `table_id` string, required

## Response `200`

Successful response

- EmployeeTableMetadata
  - `id` string: The table ID is the resource name used in the URL to access the table data, in both the per-employee and the bulk forms. For example, `work` in `/people/{id}/work` and `/bulk/people/work`
  - `name` string: The display name of the table as it appears in Bob.
  - `description` string, nullable: The description of the table
  - `categoryId` string: The ID of the category to which the table belongs
  - `categoryDisplayName` string: The display name of the category to which the table belongs
  - `historical` boolean: True if the table is effective-dated: each row has an effective date, and the entries form a history
  - `columns` CustomTableColumn[]: All the columns of the table, including the out-of-the-box columns and the custom columns defined for the table
    - `id` string: The ID of the column
    - `name` string: The name of the column
    - `description` string: The description of the column
    - `mandatory` boolean: Flag which means that column must be present during creation and its value can't be null during update
    - `type` string: The type of the column. Supported column types: text, text-area, number, date, list, multi-list, hierarchy-list, currency, employee-reference, document.
    - `typeData` object
      - `listId` string: The ID of the list in the /v1/company/named-lists endpoint.

## Other responses

- `404`: If the table doesn't exist or isn't a built-in employee table.

## Changes

- **2026-11-03** `9ac25373a355`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/hibob/apis/employee-data-api/changes/company/people/employee-tables/metadata/:table_id/get.md)

---

[API](https://skmtc.dev/hibob/apis/employee-data-api.md) - [All operations](https://skmtc.dev/hibob/apis/employee-data-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hibob/apis/employee-data-api/revisions/9ac25373a355?raw)