Search for one or more users matching certain fields.
Options
Choose between searching for:
- A single user - the first match
- All matching users
Input Fields
Use one or more of the input fields to search for.
- User
- Name (text): The name of the user
- External ID (text): An ID that you can assign to match this user with your own records
- Email (text): The user’s primary email address
- Phone (text): The user’s primary phone number
- Group (text): The user’s group name. This only applies to admin and agent users.
- Details (text): Any details about the user
- Notes (text): Any notes about the user
- Organization (text): The ID of the organization that the user is associated with
- Role (text): The role of the user. Can be “agent”, “end-user”, or “admin”.
- Tags (list of text): A list of tags associated with the user
- Custom fields
- A dynamically generated list of any custom fields associated with the account’s users
Output Fields
- Result
Depending on choice in Options returns either:- User ID (number): The ID of the first user returned in the search, OR
- User IDs (list of numbers): The IDs of all of the matches