Actions5
Get Entity Metadata
AI-generatedSummary
Retrieve detailed metadata for a specified Bullhorn entity, including its fields and their properties, with options for detail level and output format.
Inputs
- authentication — Choose between 'User Credentials (Email & Password)' or 'Enterprise Credentials (API Key)' for Bullhorn API authentication.
- entity (required) — Select the Bullhorn entity to retrieve metadata for; the list is dynamically loaded based on your Bullhorn instance.
- metadataDetail — Set the detail level of field properties to return: 'Basic' includes core properties (name, label, type, required, readOnly); 'Full' returns all properties including options, associations, and constraints.
- options.forceRefresh — Boolean option to bypass the 24-hour server-side metadata cache and fetch fresh data from Bullhorn; useful after changes to field labels, custom fields, or picklist values.
- options.includeSystemFields — Boolean to include system/internal fields in the returned metadata.
- options.includeReadOnly — Boolean to include read-only fields in the returned metadata; defaults to true.
- options.flattenToRows — Boolean to output one item per entity/field/option instead of a single item with nested arrays.
Output shape
a single item containing metadata about the specified entity, including its fields and properties as per the requested detail level
Output may optionally include system fields, read-only fields, and can be flattened into multiple items depending on options; forced refresh pulls fresh data bypassing cache.
Examples
Example 1: Retrieve basic metadata for a Candidate entity
Set 'Entity' to 'Candidate' and 'Detail Level' to 'Basic' (default), leaving other options default.