DocumentationAPI Reference
API Reference

List Custom Fields

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

Returns a paginated list of active custom fields. IDs are strings and each has a numeric legacyId companion for legacy integrations. Use this for active custom fields. For archived custom 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…
Query Params
integer
≥ 1
Defaults to 1

Page number to retrieve. Must be greater than or equal to 1.

integer
1 to 1000
Defaults to 100

Maximum number of custom fields to return per page.

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