Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation retrieves a list of cards associated with a specified account. It is useful in scenarios where you need to fetch card details for an account, such as displaying card information in dashboards, processing card-related transactions, or managing card statuses programmatically.

For example, you might use this node to:

  • Get all active cards for a user’s account.
  • Filter cards by status or user ID.
  • Paginate through large sets of cards by skipping and taking a specific number of records.

Properties

Name Meaning
Account Id Identifier of the account whose cards you want to retrieve.
Filter JSON-stringified and URL-encoded filter expression object that conforms to a card filter schema. Allows filtering cards by properties like userId and status.
Skip Number of card objects to skip from the beginning of the result set (used for pagination).
Take Maximum number of card objects to return (used for pagination).

Output

The output contains a JSON array of card objects matching the query parameters. Each card object includes details such as card identifiers, user associations, status, and other card-specific metadata depending on the API response schema.

If the node supports binary data output (not indicated here), it would typically represent card images or attachments, but this is not evident from the provided code.

Dependencies

  • Requires connection to the external API service that manages card data.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The base URL for the API must be set in the node credentials or environment variables.

Troubleshooting

  • Invalid Account Id: If the account identifier is incorrect or missing, the API will likely return an error or empty results. Ensure the Account Id is valid and correctly formatted.
  • Malformed Filter JSON: The filter property expects a JSON-stringified and URL-encoded object. Improper formatting can cause request failures. Validate the JSON structure before input.
  • Pagination Issues: Setting Skip or Take to inappropriate values (e.g., negative numbers) may lead to unexpected results or errors.
  • Authentication Errors: Missing or invalid API credentials will prevent successful API calls. Verify that the API key/token is correctly configured.
  • API Rate Limits: Excessive requests may trigger rate limiting; handle such errors by implementing retries or backoff strategies.

Links and References

  • Refer to the external API documentation for detailed card schema and filter options.
  • n8n documentation on how to configure API credentials and use query parameters effectively.

Discussion