Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation, "Get Custom Field Values" under the "Custom Fields" resource, is designed to retrieve the values of a specific custom field associated with an account. It is useful in scenarios where you need to programmatically access metadata or additional information stored as custom fields for accounts within a system. For example, if your application tracks extra attributes about customers or users via custom fields, this node can fetch those values to use in workflows such as reporting, data synchronization, or conditional logic.

Properties

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

Output

The node outputs JSON data containing the values of the specified custom field for the given account. The exact structure depends on the API response but typically includes the custom field's value(s) and possibly metadata such as timestamps or identifiers. There is no indication that binary data is returned by this operation.

Dependencies

  • Requires an API key credential to authenticate requests to the external service.
  • The base URL for the API must be configured in the node credentials.
  • Depends on the external API described by the bundled OpenAPI specification (payhawk.api.json), which defines the endpoints and operations.

Troubleshooting

  • Missing or invalid Account Id or Custom Field Id: Ensure these required properties are correctly set; otherwise, the API call will fail.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Network or connectivity issues: Confirm that the base URL is reachable and correct.
  • Unexpected API responses: Check if the custom field exists and is accessible for the given account.

Links and References

  • Refer to the external API documentation (not included here) for detailed information on custom fields and their values.
  • n8n documentation on creating and using API credentials for authentication.

Discussion