Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Custom Fields → Get Custom Field

AI-generated

Overview

This node allows you to retrieve details of a specific custom field associated with an account. It is useful when you need to fetch metadata or configuration stored as custom fields in an external system, for example, to display or process that data further in your workflow.

Practical examples include:

  • Fetching a custom field value to personalize communications.
  • Retrieving configuration settings stored as custom fields before executing conditional logic.
  • Integrating with external systems where custom fields hold important identifiers or flags.

Properties

Name Meaning
Account Id Identifier of the account from which to get the custom field.
Custom Field Id Identifier of the specific custom field to retrieve.

Output

The node outputs a JSON object representing the retrieved custom field's data. This typically includes all properties and values associated with that custom field as returned by the external API.

If the node supports binary data output (not evident here), it would represent any file or media content related to the custom field.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to access the external service.
  • The node depends on an external API endpoint that provides custom field data based on account and custom field identifiers.
  • Proper base URL and headers must be set in the node credentials or configuration to communicate with the API.

Troubleshooting

  • Missing or invalid Account Id or Custom Field Id: Ensure these required inputs are provided and correctly formatted.
  • Authentication errors: Verify that the API key or authentication token is valid and has sufficient permissions.
  • API connectivity issues: Check network connectivity and correct base URL configuration.
  • Custom field not found: If the specified custom field ID does not exist for the given account, the API may return a 404 error; verify IDs are correct.
  • Unexpected response format: Confirm that the external API version matches what the node expects.

Links and References

  • Refer to the external API documentation for details on custom fields and their structure.
  • Consult n8n documentation on how to configure API credentials and handle HTTP request nodes for similar integrations.

Discussion