BAbamboohr
Custom Tables
Public API

Get Custom Table

Changed on

Returns one custom table definition with its fields. IDs are strings and each has a numeric legacyId companion for legacy integrations. Use this for a known custom table ID. For browsing active custom tables, use List Custom Tables (list-custom-tables) instead.

OAuth Scopes: employee:custom_fields

get/api/v1/hris/custom-tables/{customTableId}

Request

Path parameters

customTableIdstring required
Example:123

The ID of the custom table to retrieve

Response

Custom table definition.

idstring

The string custom field or custom table ID.

legacyIdinteger

The legacy numeric custom field or custom table ID.

namestring

The custom field or custom table name.

typestring

The custom field or custom table type.

isEncryptedboolean

Whether the custom field is encrypted.

isCalculatedboolean

Whether the custom field is calculated.

isRequiredboolean

Whether the custom field is required.

orderinteger nullable

The display order.

pageIdstring nullable

The string parent tab/page ID.

pageLegacyIdinteger nullable

The legacy numeric parent tab/page ID.

sectionIdstring nullable

The string parent section ID.

sectionLegacyIdinteger nullable

The legacy numeric parent section ID.

customTableIdstring nullable

The string parent custom table ID when this is a custom table field.

customTableLegacyIdinteger nullable

The legacy numeric parent custom table ID when this is a custom table field.

sortOrderDirectionstring nullable

The custom table sort order direction.

summarizestring nullable

The custom table field summary setting.

sortFieldboolean nullable

Whether this custom table field is the table sort field.

fieldsCustomFieldDefinitionResponseObject[] circular

Changes