Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation "Get Custom Fields" under the "Custom Fields" resource is designed to retrieve custom field data associated with a specific account. It is useful in scenarios where you need to fetch metadata or additional configurable fields tied to an account entity, such as for dynamic form generation, reporting, or integration workflows that depend on custom attributes.

For example, if your system allows users to define custom fields per account (like "Customer Tier", "Preferred Contact Method", etc.), this node can be used to programmatically obtain those fields and their values to use downstream in your automation.

Properties

Name Meaning
Account Id Identifier of the account whose custom fields you want to retrieve

Output

The node outputs JSON data containing the custom fields related to the specified account. The structure typically includes key-value pairs representing each custom field's name and its corresponding value or metadata.

If the node supports binary data output, it would generally represent attachments or files linked to custom fields, but based on the provided code and context, the output is primarily JSON.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to access the external service providing the custom fields.
  • The node depends on an external API endpoint that returns custom field data for accounts.
  • Proper base URL and authentication credentials must be set up in n8n for successful API communication.

Troubleshooting

  • Missing or invalid Account Id: Ensure the "Account Id" property is correctly set and corresponds to an existing account; otherwise, the API may return errors or empty results.
  • Authentication errors: Verify that the API key or authentication token is valid and has sufficient permissions to read custom fields.
  • API connectivity issues: Check network connectivity and correct base URL configuration.
  • Unexpected response format: If the API changes its response schema, the node might fail to parse the output correctly.

Links and References

  • Refer to the external API documentation for details on the custom fields endpoint.
  • n8n documentation on how to configure API credentials and handle HTTP requests.

Discussion