Skip to main content
GET
Get Custom Field

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

custom_field_id
string<uuid>
required

Response

Successful Response

id
string<uuid>
required

Unique identifier of the custom field.

Example:

"018e586b-7d0b-7bc9-be65-a8fdbc82d734"

name
string
required

Name of the custom field (snake_case).

Example:

"guardian_mobile"

category
enum<string>
required

Category of the model.

Available options:
HRIS,
ATS,
LMS
Example:

"HRIS"

model
string
required

Model on which the custom field is applied.

Example:

"employee"

source
enum<string>
required

Origin of the custom field. 'API' if created through the public API, 'DASHBOARD' if created from the Bindbee dashboard.

Available options:
DASHBOARD,
API
Example:

"API"

created_at
string<date-time>
required
mapping_counts
CustomFieldMappingCounts · object
required

Counts of mappings for this custom field, broken down by scope.

description
string | null

Description of the custom field.

Example:

"Employee's guardian mobile number"

updated_at
string<date-time> | null
mappings
CustomFieldMappingExternal · object[]

All mappings configured for this custom field.