AvantGuard - ClerkChat icon

AvantGuard - ClerkChat

AvantGuard - ClerkChat

Overview

This node operation retrieves the list of users belonging to a specific team within a reseller context. It is useful for scenarios where you need to manage or audit team members, synchronize user data, or display team compositions in dashboards or reports. For example, a company using this node can fetch all users assigned to a sales team to analyze performance or update permissions.

Properties

Name Meaning
Team Id The unique identifier of the team whose users you want to retrieve.
Additional Query Parameters Optional filters and pagination controls:
- Query: Search users by name.
- Skip: Number of users to skip (for pagination).
- Take: Number of users to return (limit results).

Output

The output contains a JSON array of user objects representing the users in the specified team. Each user object typically includes details such as user ID, name, email, role, and other relevant metadata depending on the API response schema.

If binary data were involved (e.g., user avatars), it would be included separately, but this operation focuses on JSON user data only.

Dependencies

  • Requires an API key credential for authenticating requests to the external service managing reseller teams.
  • The node uses a base URL configured via credentials to connect to the appropriate API endpoint.
  • No additional external dependencies are indicated beyond the bundled OpenAPI client library.

Troubleshooting

  • Missing or invalid Team Id: Ensure the "Team Id" property is provided and correctly formatted; otherwise, the API may return errors or empty results.
  • Authentication errors: Verify that the API key credential is valid and has sufficient permissions to access team user data.
  • Pagination issues: If too many users are returned or none appear, adjust the "Skip" and "Take" parameters appropriately.
  • Network or API errors: Check connectivity and API status if requests fail unexpectedly.

Links and References

  • Refer to the external API documentation for detailed information about the team users endpoint, query parameters, and response structure.
  • Consult n8n documentation on how to configure API key credentials and use collection-type input properties for advanced querying.

Discussion