BAbamboohr
Custom Fields
Public API

Get Custom Field

Changed on

Returns one custom field definition. IDs are strings and each has a numeric legacyId companion for legacy integrations. Use this for a known custom field ID. For browsing active fields, use List Custom Fields (list-custom-fields) instead. For archived fields, use List Archived Custom Fields (list-archived-custom-fields) instead.

OAuth Scopes: employee:custom_fields

get/api/v1/hris/custom-fields/{customFieldId}

Request

Path parameters

customFieldIdstring required
Example:123

The ID of the custom field to retrieve

Response

Custom field 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