Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Custom Fields → Get Custom Fields

AI-generated

Overview

This node operation, "Get Custom Fields" under the "Custom Fields" resource, retrieves custom field data associated with a specific account. It is useful when you need to fetch metadata or additional configurable fields tied to an account in your system. For example, if you manage customer accounts and have custom attributes defined for each, this operation allows you to programmatically access those custom attributes for reporting, integration, or automation purposes.

Properties

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

Output

The output JSON contains the custom fields data related to the specified account. This typically includes key-value pairs or structured objects representing each custom field's name, type, and value. The exact structure depends on the external API response but generally provides all configured custom fields for the given account ID.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API key credential for authentication (referred generically as "an API key credential").
  • The node interacts with an external API endpoint defined by the base URL configured in the credentials.
  • The request headers specify Accept: application/json and Content-Type: application/json.
  • The node uses an OpenAPI-based client internally to build requests and parse responses.

Troubleshooting

  • Missing or invalid Account Id: Since the Account Id is required, ensure it is provided and correctly formatted. Errors may occur if this property is empty or incorrect.
  • Authentication errors: If the API key credential is missing or invalid, the node will fail to authenticate. Verify that the API key is set up properly in n8n credentials.
  • Network or API errors: Connection issues or API downtime can cause failures. Check network connectivity and API status.
  • Unexpected response format: If the external API changes its response schema, the node might not parse the custom fields correctly. Review API documentation and update the node if necessary.

Links and References

  • Refer to the external API documentation for details on the custom fields endpoint and expected response format.
  • n8n documentation on how to configure API key credentials and use HTTP-based nodes.

Discussion