HIhibob
Metadata

Read metadata for a specific built-in employee table

Changed on

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}.

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
    • HTTP basic
    • or HTTP bearer

Path parameters

table_idstring required

The ID of the out-of-the-box employee table. Use /company/people/employee-tables/metadata to fetch all table IDs.

Response

Successful response

idstring

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

namestring

The display name of the table as it appears in Bob.

descriptionstring nullable

The description of the table

categoryIdstring

The ID of the category to which the table belongs

categoryDisplayNamestring

The display name of the category to which the table belongs

historicalboolean

True if the table is effective-dated: each row has an effective date, and the entries form a history

Example response

{
  "id": "salaries",
  "name": "Salary",
  "description": null,
  "categoryId": "payroll",
  "categoryDisplayName": "Payroll",
  "historical": true,
  "columns": [
    {
      "id": "effectiveDate",
      "name": "Effective date",
      "description": null,
      "mandatory": true,
      "type": "date",
      "typeData": {}
    },
    {
      "id": "base",
      "name": "Base salary",
      "description": null,
      "mandatory": true,
      "type": "currency",
      "typeData": {}
    },
    {
      "id": "payPeriod",
      "name": "Salary pay period",
      "description": null,
      "mandatory": true,
      "type": "list",
      "typeData": {
        "listId": "payPeriod"
      }
    },
    {
      "id": "payFrequency",
      "name": "Salary pay frequency",
      "description": null,
      "mandatory": true,
      "type": "list",
      "typeData": {
        "listId": "payFrequency"
      }
    },
    {
      "id": "reason",
      "name": "Reason",
      "description": null,
      "mandatory": false,
      "type": "text",
      "typeData": {}
    },
    {
      "id": "changedBy",
      "name": "Changed by",
      "description": null,
      "mandatory": false,
      "type": "text",
      "typeData": {}
    },
    {
      "id": "endEffectiveDate",
      "name": "End effective date",
      "description": null,
      "mandatory": false,
      "type": "date",
      "typeData": {}
    },
    {
      "id": "column_1793300200363",
      "name": "Cost center code",
      "description": "Internal cost center code for the salary entry",
      "mandatory": false,
      "type": "text",
      "typeData": {}
    }
  ]
}

Changes