Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation retrieves the list of users associated with a specific account. It is useful in scenarios where you need to manage or audit user access within an account, such as fetching all users for review, synchronizing user data with another system, or automating user-related workflows.

For example, you might use this node to:

  • Get all users linked to a particular account to send notifications.
  • Audit user permissions by listing all account users.
  • Integrate with other systems that require up-to-date user lists per account.

Properties

Name Meaning
Account Id Identifier of the account whose users you want to retrieve.
Filter JSON-stringified and URL-encoded filter expression object to narrow down the users returned. This filter must conform to the expected schema for account user filtering.

Output

The output contains a JSON array of user objects associated with the specified account. Each user object typically includes details such as user identifiers, names, roles, and other relevant metadata depending on the API response.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authentication to the external service managing accounts and users.
  • The node expects a base URL configuration for the API endpoint.
  • The operation uses HTTP GET requests with query parameters for filtering.

Troubleshooting

  • Invalid Account Id: If the provided account identifier does not exist or is malformed, the node may return an error or empty results. Verify the account ID is correct.
  • Filter Syntax Errors: The filter property must be a valid JSON string and properly URL-encoded. Malformed filters can cause request failures.
  • Authentication Issues: Ensure the API key credential is correctly configured and has sufficient permissions to read account user data.
  • Network or API Errors: Check connectivity and API availability if requests fail unexpectedly.

Links and References

  • Refer to the external API documentation for detailed information on the account user filter schema (IAccountUserFilter) and available user fields.
  • Consult your API provider’s authentication guide to set up the required API key credentials.

Discussion