CiviCRMInstall

Summary

Lists field metadata for the selected CiviCRM APIv4 entity by calling its getFields action. Use it to inspect available fields before configuring a search or API call; the Action Context defaults to get and affects which fields are reported as required or readonly.

Inputs

• Entity (required) — CiviCRM APIv4 entity to inspect, such as Contact, Membership, or a custom entity.
• Action Context — Context passed to getFields, such as get, create, or update; defaults to get.
• Runtime Bearer Token (Optional) — Optional per-item JWT, which is sent as provided and bypasses credential-based authentication and API-key fallback. Leave empty to use the configured credential.
• Base URL Override — Optional per-item CiviCRM site root URL; if omitted, the credential's Base URL is used. A scheme-less value is treated as HTTPS; only HTTP and HTTPS are allowed.

Output shape

A list of field metadata items, one per returned field.

Each item contains the corresponding metadata object from the API's values array. If no values are returned, the operation emits one item containing the API response, or an empty object if there is no response. API errors are thrown unless the node is configured to continue on fail.

Examples

Example 1: Inspect fields available for creating a Contribution

Set Entity to Contribution and Action Context to create to request field metadata in the create context.

Links

• n8n community nodes installation guide