AvantGuard - WebhookSite icon

AvantGuard - WebhookSite

AvantGuard - WebhookSite
Join our community

Actions109

Overview

The "Get Users" operation of the Users resource retrieves a list of users from an external system, allowing filtering and pagination through various query parameters. This node is useful when you want to fetch user data for reporting, synchronization, or automation workflows that depend on user information.

Common scenarios include:

  • Retrieving all users with a specific role or security level.
  • Searching users by first name, last name, or email.
  • Filtering users who belong to a particular company (portal members).
  • Paginating through large sets of users to process them in batches.

For example, you could use this node to get all active administrators in your system or to search for users whose names match a certain pattern.

Properties

Name Meaning
Additional Query Parameters Optional filters and pagination controls to refine the user list. Options include:
- First Name Filter users by their first name (string).
- Last Name Filter users by their last name (string).
- Search Search across both first name and last name fields (string).
- Portal Member Company Id Filter users by company ID; applicable only to portal members (number).
- Archived Filter users based on archived status (boolean).
- Email Filter users by email address (string).
- Security Level Filter users by security level. Possible values: 'super_admin', 'admin', 'spectator', 'editor', 'author', 'portal_member', 'portal_admin' (string).
- Page The page number of results to retrieve (number). Useful for pagination.
- Page Size Number of results per page (number).

Output

The node outputs JSON data containing the list of users matching the specified filters and pagination settings. Each item in the output corresponds to a user object with properties as returned by the external API.

If the external API supports binary data related to users (e.g., profile pictures), it would be included in the binary output, but based on the provided code and properties, this node primarily outputs JSON user data.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to access the external user management API.
  • The base URL for the API must be set in the node credentials.
  • Depends on the external service's REST API endpoint for fetching users.

Troubleshooting

  • Empty Results: If no users are returned, verify that the filter parameters are correct and that users matching those criteria exist.
  • Authentication Errors: Ensure that the API key or authentication token is valid and has sufficient permissions to read user data.
  • Pagination Issues: If not all users are retrieved, check the Page and Page Size parameters to paginate through all available data.
  • Invalid Parameter Values: Passing unsupported values for filters like security_level may cause errors or empty responses. Use only documented values.
  • Network or API Errors: Check connectivity and API availability if requests fail.

Links and References

  • Refer to the external API documentation for detailed descriptions of user fields, security levels, and query parameter usage.
  • n8n documentation on how to configure API credentials and use HTTP request nodes for custom integrations.

Discussion