Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Custom Fields → Get A Custom Field Value

AI-generated

Overview

This node operation retrieves the value of a specific custom field associated with an account. It is useful when you need to fetch detailed or user-defined metadata stored as custom fields in an external system, allowing workflows to dynamically access and use these values for further processing or decision-making.

Practical examples include:

  • Fetching a customer’s preferred contact method stored as a custom field.
  • Retrieving a project-specific setting or flag saved as a custom field value.
  • Accessing additional attributes linked to an account that are not part of standard data fields.

Properties

Name Meaning
Account Id Identifier of the account from which the custom field value will be retrieved.
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 requested custom field value. This typically includes all relevant details about the custom field value such as its identifier, actual value, and possibly metadata like timestamps or related references depending on the external API's response structure.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to connect to the external service managing custom fields.
  • The node uses a base URL and headers preset for JSON communication, implying REST API interaction.
  • No other external dependencies or environment variables are explicitly required based on the provided code.

Troubleshooting

  • Missing or incorrect identifiers: Ensure that the Account Id, Custom Field Id, and Custom Field Value Id are correctly specified; otherwise, the API may return errors or empty results.
  • Authentication issues: Verify that the API key or authentication credentials are valid and have sufficient permissions to access custom field data.
  • Network or API errors: Check connectivity and API endpoint availability if requests fail or time out.
  • Unexpected response format: If the output JSON does not match expectations, confirm that the external API schema has not changed.

Links and References

  • Refer to the external service’s API documentation for details on custom fields and their values.
  • n8n documentation on creating and using API credentials.
  • General REST API best practices for troubleshooting connection and data retrieval issues.

Discussion