Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation retrieves the value of a specific custom field from an account. It is useful when you need to access detailed, user-defined data associated with an account in your system, such as preferences, metadata, or additional attributes that are not part of the standard account information.

Practical examples include:

  • Fetching a user's preferred language stored as a custom field.
  • Retrieving a custom status or tag assigned to an account for segmentation.
  • Accessing any specialized data point configured as a custom field for reporting or automation purposes.

Properties

Name Meaning
Account Id Identifier of the account from which to retrieve the custom field value.
Custom Field Id Identifier of the custom field whose value you want to get.
Custom Field Value Id Identifier of the specific value instance of the custom field to retrieve.

Output

The output contains a JSON object representing the retrieved custom field value. This typically includes the details and content of the custom field value identified by the provided IDs. The exact structure depends on the API response but generally includes fields like the value itself, metadata, and identifiers.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to connect to the external service managing accounts and custom fields.
  • The node uses a base URL and headers preset for JSON communication with the API.
  • No other external dependencies are explicitly required.

Troubleshooting

  • Missing or incorrect IDs: Ensure that the Account Id, Custom Field Id, and Custom Field Value Id are correct and correspond to existing entities; otherwise, the API will likely return errors or empty results.
  • Authentication errors: Verify that the API key or authentication token is valid and has sufficient permissions to read custom field values.
  • Network issues: Check connectivity to the API endpoint and confirm the base URL is correctly set in credentials.
  • API changes: If the external API changes its schema or endpoints, the node may fail; verify compatibility if errors occur after updates.

Common error messages might include "Not Found" (invalid IDs), "Unauthorized" (authentication failure), or "Bad Request" (malformed input). Resolving these involves verifying inputs, credentials, and network settings.

Links and References

  • Refer to the external API documentation for custom fields management to understand the meaning of IDs and expected responses.
  • n8n documentation on how to configure API credentials and use HTTP request nodes for troubleshooting connectivity.

Discussion