DocumentationAPI Reference
API Reference

Get Custom Field

get
https://{companyDomain}.bamboohr.com/api/v1/hris/custom-fields/

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^[1-9]\d*$

The ID of the custom field to retrieve

Responses

Updated about 9 hours ago

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 9 hours ago