Actions10
List Users
AI-generatedSummary
Retrieve a paginated list of users from the DocRouter.ai account with optional filtering by organization ID and case-insensitive search on user name or email.
Inputs
- Limit — Maximum number of users to return (minimum 1, maximum 100). Defaults to 10.
- Skip — Number of users to skip for pagination. Defaults to 0.
- Organization ID — Filter results to users belonging to a specific organization by its ID.
- Search Name — Case-insensitive search string to filter users by matching their name or email.
Output shape
a single JSON object containing an array of users matching the criteria.
The operation runs once per execution and returns users in a paginated form based on the limit and skip parameters. If no users match, an empty list is returned. Errors produce an error object if the node is set to continue on fail.
Examples
Example 1: List the first 10 users without filters
Set Limit to 10 (default), Skip to 0, leave Organization ID and Search Name empty.
Example 2: List users skipping the first 20 and filtering by organization
Set Limit to desired number (up to 100), Skip to 20, provide the Organization ID to filter users by that organization.
Example 3: Search for users with 'john' in name or email
Set Search Name to 'john' (case-insensitive), optionally set Limit and Skip as needed.