Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation, "Display Team Members Response Object" under the "Account Teams" resource, is designed to retrieve and display information about members of a specific team within an account. It is useful in scenarios where you need to manage or audit team membership, verify user roles, or integrate team data into workflows for collaboration or reporting purposes.

For example, a company using this node can fetch all members of a sales team to send targeted notifications or generate reports on team activity.

Properties

Name Meaning
Account Id Identifier of the account
Team Id Identifier of the team whose members to show

Both properties are required string inputs that specify which account and team the operation will query.

Output

The output of this operation is a JSON object representing the response containing the team members' details. This typically includes member identifiers, names, roles, and possibly other metadata related to each team member. The exact structure depends on the API's response schema but generally provides comprehensive information about the team composition.

No binary data output is indicated.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to access the external service.
  • The node uses a base URL provided by credentials to make HTTP requests.
  • Depends on an OpenAPI specification (payhawk.api.json) for defining operations and properties.
  • Uses external libraries such as lodash for utility functions and a custom OpenAPI node helper for building properties and parsing operations.

Troubleshooting

  • Missing or invalid Account Id or Team Id: Ensure both IDs are correctly provided; otherwise, the API call will fail or return no data.
  • Authentication errors: Verify that the API key or authentication token is correctly set up in n8n credentials.
  • Network or API endpoint issues: Check connectivity and that the base URL is correct.
  • Unexpected response format: If the API changes, the node might not parse the response correctly; updating the OpenAPI spec or node code may be necessary.

Links and References

  • Refer to the external API documentation for detailed information on the team members' response object structure.
  • n8n documentation on creating and configuring API credentials.
  • lodash library: https://lodash.com/
  • OpenAPI Specification: https://swagger.io/specification/

Discussion