Actions5
Discover Filterable Fields
AI-generatedSummary
Discover all filterable fields for a specified Bullhorn entity, classifying them by type and priority and optionally including system and read-only fields or forcing a metadata cache refresh.
Inputs
- authentication — Choose the authentication method: User Credentials (Email & Password) or Enterprise Credentials (API Key). Defaults to Enterprise Credentials.
- entity (required) — The Bullhorn entity name to inspect for filterable fields, dynamically populated from your Bullhorn instance.
- options.forceRefresh — Whether to bypass the 24-hour server-side metadata cache to fetch fresh data from Bullhorn. Use this after changes to field labels, custom fields, or picklist values. Defaults to false.
- options.includeSystemFields — Whether to include system or internal fields in the discovered results. Defaults to false.
- options.includeReadOnly — Whether to include read-only fields in the discovered results. Defaults to true.
- options.flattenToRows — Whether to output one item per entity/field/option instead of a single item with nested arrays. Defaults to false.
Output shape
a single JSON object containing the discovery result with classified filterable fields, their types, priorities, and filter recommendations
The output includes detailed metadata about each filterable field for the selected entity, with optional inclusion of system and read-only fields depending on inputs. The flattenToRows option changes how results are structured.
Examples
Example 1: Get filterable fields for the Candidate entity including read-only fields but excluding system fields, without forcing cache refresh.
Set entity to 'Candidate', options.includeReadOnly to true, options.includeSystemFields to false, options.forceRefresh to false.
Example 2: Fetch fresh filterable fields for the JobOrder entity bypassing the metadata cache and include system fields.
Set entity to 'JobOrder', options.forceRefresh to true, options.includeSystemFields to true.