Custom Fields

Returns information about a company's custom fields

Field

Description

Scopes Needed

Inline Expansion

Results Filter

name

Name of custom field

custom_fields

No

?name=Hoodie+size

custom_field_type

Type of custom field. Will be one of the following

"single_line_text"
"multi_line_text"
"date"
"number"
"multiple_choice"
"file"
"yes_or_no"
"signature"

custom_fields

No

No

help_url

Nullable. Only applicable for "file" type - the URL of the optional File Attachment uploaded during creation of the custom field

custom_fields

No

No

help_text

Nullable. The help text for the custom field

custom_fields

No

No

media_file_type

Nullable. The file type of the optional Help Media File uploaded during creation of the custom field

custom_fields

No

No

help_url_media

Nullable. The URL of the optional Help Media File uploaded during creation of the custom field

custom_fields

No

No

can_manager_view_field

Whether the person's manager can view this field

custom_fields

No

No

is_sensitive

Whether this is a sensitive field

Only admins who aren't restricted from viewing sensitive fields will be able to view sensitive custom fields.

custom_fields

No

No

is_field_completer_person

Whether this field is completed by the company or the person themselves. true if field should be completed by the person themselves

custom_fields

No

No

can_person_view_field

Whether this field is visible by the person themselves (always true if is_field_completer_person is true)

custom_fields

No

No

can_person_edit_field

Whether this field is editable by the person themselves (always false if can_person_view_field is false)

custom_fields

No

No

company_during_hiring

Whether this field needs to be completed by the company (via the admin or manager) during hiring. Always false if is_field_completer_person is true

custom_fields

No

No

person_during_onboarding

Whether this field needs to be completed by the person themselves during onboarding. Always false if is_field_completer_person is false

custom_fields

No

No

is_field_required

Whether this field is required or not.

custom_fields

No

No

custom_field_values

The Custom Field Values for this custom field

custom_fields
people.custom_field_values

No

No

Variations of this endpoint:

The following endpoint gives all the information relating to a single custom field

http://api.trinet.com/core/custom_fields/{:id}

Reminder
It's a list API and hence is subject to Pagination. By default limit for each page is 20 records. Incase there are more pages please do increase the limit.
e.g.: "https://api.trinet.com/core/custom_fields?limit=30"

Language
Credentials
Header