BAbamboohr
Custom Tables
Public API

List Custom Tables

Changed on

Returns a paginated list of active custom tables with their fields. IDs are strings and each has a numeric legacyId companion for legacy integrations. Use this for browsing active custom tables. For a known custom table ID, use Get Custom Table (get-custom-table) instead.

OAuth Scopes: employee:custom_fields

get/api/v1/hris/custom-tables

Request

Query parameters

pageinteger

Page number to retrieve. Must be greater than or equal to 1.

pageSizeinteger

Maximum number of custom tables to return per page.

Response

Paginated list of active custom tables.

_linksobject nullable

Hypermedia links for collection navigation (next, prev) and available collection actions (e.g., create). Actions are permission-based and may vary.

Example response

{
  "meta": {
    "pageSize": 100,
    "totalPages": 1,
    "totalItems": 10
  },
  "_links": {
    "next": {
      "href": "/api/v1/reference-resources?page=2&pageSize=100"
    },
    "prev": {
      "href": "/api/v1/reference-resources?page=0&pageSize=100"
    }
  }
}

Changes