Actions5
Get Field Options
AI-generatedSummary
Retrieve the selectable options for a specified field on a Bullhorn entity, resolving dynamic option sources such as inline lists, system options, or entity lookups, with control over caching and filtering behavior.
Inputs
- authentication — Select the authentication method for the request: user credentials (email and password) or enterprise API key.
- entity (required) — The Bullhorn entity name to inspect (e.g., 'Candidate'). This is dynamically loaded from your Bullhorn instance.
- field (required) — The name of the field on the specified entity for which to retrieve valid options.
- options.forceRefresh — Boolean flag to bypass the default 24-hour cache and fetch fresh options data directly from Bullhorn. Use after metadata changes such as field label edits, custom field additions, or picklist value updates.
- options.includeSystemFields — Boolean flag to include system/internal fields in the results. Defaults to false.
- options.includeReadOnly — Boolean flag to include read-only fields in the results. Defaults to true.
- options.flattenToRows — Boolean flag to flatten the output into one item per entity/field/option instead of a single item with nested arrays.
Output shape
a list of option objects representing the valid selectable values for the specified field on the entity
The returned options are resolved dynamically from either inline metadata options, system option sets, or entity lookups, depending on the field's configuration. The operation caches option data by default for 24 hours but can be forced to refresh. Output can be nested or flattened based on the flattenToRows boolean option.
Examples
Example 1: Retrieve picklist options for the 'status' field on the 'Candidate' entity with cache refresh
Set 'entity' to 'Candidate', 'field' to 'status', and 'options.forceRefresh' to true.