Actions5
Get Entity Metadata
AI-generatedSummary
Retrieve metadata for a specified Bullhorn entity, including detailed field information with configurable depth and filtering options.
Inputs
- Authentication (required) — Choose between 'User Credentials (Email & Password)' or 'Enterprise Credentials (API Key)' for authenticating the Bullhorn API request.
- Entity (required) — The Bullhorn entity to retrieve metadata for, dynamically loaded from your Bullhorn instance (e.g., 'Candidate').
- Detail Level — Select metadata detail level: 'Basic' returns core field properties (name, label, type, required, readOnly), while 'Full' returns all field properties including options, associations, and constraints. Defaults to 'Basic'.
- Options — Additional options to customize metadata retrieval, including: forceRefresh (bypass Bullhorn's 24-hour cache to fetch fresh data), includeSystemFields (whether internal fields are included), includeReadOnly (whether read-only fields are included), and flattenToRows (whether to output results as multiple items vs. a nested single item).
Output shape
a single item containing the entity metadata object with detailed field descriptions; optionally flattened into multiple items per entity/field/option if flattenToRows is enabled
The metadata returned includes fields, their properties, and optionally associations and constraints depending on selected detail level. The results reflect any applied options and may represent cached data unless forceRefresh is enabled.