BAbamboohr
Custom Tables
Public API

Create Custom Table

Changed on

Creates a new custom table together with its columns in a single request. The tab value is the target tab's page ID; use Custom Fields > List Custom Fields (list-custom-fields) to find the pageId of an existing field on the desired tab. Use this to create a table backed by multiple columns. For adding a column to a table that already exists, use Create Custom Table Field (create-public-custom-table-field) instead. For a single standalone field not backed by a table, use Custom Fields > Create Custom Field (create-public-custom-field) instead.

OAuth Scopes: employee:custom_fields.write

post/api/v1/hris/custom-tables

Request

Request body

idinteger

The id of the Custom Table. Ignored on write: the table id always comes from the path (edit) or is assigned by the server (create).

namestring required

The name of the Custom Table to be edited / created

type'grid' | 'history' required

The type of the Custom Table to be edited / created

sortOrderDirection'asc' | 'desc'

The sort order direction of the Custom Table

allowEditsboolean

Whether the Custom Table allows edits or not

Response

Custom table created.

idinteger

The id of the Custom Table

namestring

The name of the Custom Table

typestring

The type of the Custom Table

isEncryptedboolean

Whether the Custom Table is encrypted or not

isCalculatedboolean

Whether the Custom Table is calculated or not

isRequiredboolean

Whether the Custom Table is required or not

orderinteger

The order of the Custom Table

summarize'none' | 'total' | 'average'

The aggregation applied when computing totals for this field. Only meaningful for custom table columns; always "none" for standalone custom fields and for the custom table object itself.

valuesstring[]

The values of the Custom Field

sortOrderDirectionstring

The sort order direction of the Custom Table

Changes