Actions5
List Entities
AI-generatedSummary
Retrieve a list of all available Bullhorn entities along with optional inclusion of system and read-only fields, and control over data caching and output structure.
Inputs
- authentication (required) — Choose between 'User Credentials (Email & Password)' or 'Enterprise Credentials (API Key)' for Bullhorn authentication.
- options — Optional parameters to customize the list retrieval, including 'Force Refresh' to bypass cache, 'Include System Fields' to include internal fields, 'Include Read-Only Fields' to include read-only fields, and 'Flatten to Rows' to output each entity field as individual items instead of nested arrays.
Output shape
a list of Bullhorn entities and their metadata returned as either a single item with nested fields or as multiple flattened items per entity/field based on 'Flatten to Rows' option
By default, the operation returns the cached entity list unless 'Force Refresh' is set to true, which fetches fresh data from Bullhorn server bypassing the 24-hour metadata cache. The output includes entity details, optionally system/internal and read-only fields depending on options selected.
Examples
Example 1: List entities with default caching and include read-only fields
Authentication set to Enterprise Credentials; no options added (default values) resulting in cached data and read-only fields included but system fields excluded.
Example 2: List entities forcing a metadata cache refresh and including system fields
Authentication using User Credentials; Options set to forceRefresh=true and includeSystemFields=true to see updated entities including internal fields from the Bullhorn server.