BAbamboohr
Custom Tables
Public API

Reorder Custom Table Fields

Changed on

Reorder a custom table's columns. Requires the acting user to be an owner-admin. The columns array must include the ID of every field currently in the table; a partial list or an ID that does not belong to this table is rejected with a 422. Any id in the request body is ignored; the table reordered is always the one identified by the path. Returns the full updated custom table, including all fields in their new order. Use this for a lightweight pure-reorder without resending field definitions; to add, remove, or edit fields while also reordering, use Update Custom Table (update-public-custom-table) instead.

OAuth Scopes: employee:custom_fields.write

patch/api/v1/hris/custom-tables/{customTableId}/fields/reorder

Request

Path parameters

customTableIdstring required
Example:123

The ID of the custom table to reorder fields in.

Request body

idinteger

Custom table ID. Ignored on write: the table id always comes from the path.

columnsinteger[] required

Array of custom field IDs in the new order. Must include the ID of every field currently in the table.

Response

The reordered custom table object.

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