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 retrieving current account users.
  • Integrate with other systems that require up-to-date user lists from your accounts.

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. The 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's response structure.

No binary data output is produced by this operation.

Dependencies

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

Troubleshooting

  • Common issues:

    • Invalid or missing Account Id will result in errors or empty responses.
    • Malformed filter JSON can cause request failures; ensure the filter is properly JSON-stringified and URL-encoded.
    • Authentication errors if the API key or credentials are not set correctly.
  • Error messages:

    • "Unauthorized" or "Authentication failed": Check that the API key credential is configured and valid.
    • "Invalid filter format": Verify the filter JSON syntax and encoding.
    • "Account not found": Confirm the Account Id exists and is correct.

Links and References

  • Refer to the external API documentation for detailed schema of account users and filter expressions.
  • n8n documentation on how to configure API credentials and use JSON input properties.

Discussion