Actions5
List Entities
AI-generatedSummary
List all available Bullhorn entities accessible via the connected instance, optionally bypassing the server-side metadata cache and including system or read-only fields in the output. Provide the entity catalog as structured metadata about each entity.
Inputs
- authentication (required) — Authentication method, either 'User Credentials (Email & Password)' or 'Enterprise Credentials (API Key)'.
- forceRefresh — Boolean to bypass the 24-hour metadata cache and fetch fresh data from Bullhorn, useful after changes to field labels, custom fields, or picklist values.
- includeSystemFields — Boolean to include system/internal fields in the listed entity metadata.
- includeReadOnly — Boolean to include read-only fields in the listed entity metadata.
- flattenToRows — Boolean to output each entity/field/option as a separate item instead of as a single item with nested arrays.
Output shape
a list of objects representing entity metadata information
The output may include nested arrays of fields, with optional system and read-only fields depending on input parameters. 'flattenToRows' changes the output to emit multiple items per entity field option instead of nested arrays. The listing reflects data accessible from the Bullhorn instance and may be cached unless forceRefresh is set.
Examples
Example 1: Fetch all entities using API key authentication, including read-only fields but excluding system fields, without forcing cache refresh.
authentication='enterprise', includeReadOnly=true, includeSystemFields=false, forceRefresh=false
Example 2: Fetch fresh entity metadata bypassing cache, flattening output to one entity/field/option per item for easier iteration.
forceRefresh=true, flattenToRows=true