Actions5
Discover Filterable Fields
AI-generatedSummary
Discover filterable fields for a specified Bullhorn entity by analyzing its metadata, classifying fields by type and priority, and generating filter recommendations to assist in building effective filters.
Inputs
- authentication — Choose between User Credentials (Email & Password) or Enterprise Credentials (API Key) for authenticating with Bullhorn.
- entity (required) — The Bullhorn entity to inspect (e.g., 'Candidate'). Options are loaded dynamically from your Bullhorn instance.
- options — Additional settings including whether to bypass cache (force refresh), include system/internal fields, include read-only fields, and flatten output to rows.
Output shape
A single item containing a comprehensive discovery result object with classified filterable fields and recommended filter combinations for the chosen entity.
The output may include nested arrays unless 'Flatten to Rows' is set true, which produces one item per entity/field/option instead of nested data. Cached data might be used unless 'Force Refresh' is enabled to fetch fresh data from Bullhorn.
Examples
Example 1: Discover all filterable fields for the Candidate entity using enterprise API key authentication and include read-only fields but exclude system fields, with default nested output.
authentication='enterprise', entity='Candidate', options={includeReadOnly: true, includeSystemFields: false, forceRefresh: false, flattenToRows: false}