HIhibob
Metadata

Read metadata of the built-in employee tables

Changed on

Returns the schema of the built-in (out-of-the-box) employee tables that have a data endpoint. For each table, 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.

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.

get/company/people/employee-tables/metadata

Request

  • Base URL
    https://api.hibob.com/v1
  • URL
    https://api.hibob.com/v1/company/people/employee-tables/metadata
  • Auth
    • HTTP basic
    • or HTTP bearer

Response

Successful response

Example response

{
  "tables": [
    {
      "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