Search users

This activity retrieves one or more CloudLink users or PBX contacts matching a provided search term, such as a name or mobile number. The search term can be characters corresponding to a dial keypad or the actual name or number value. An array of matching users and contacts are returned.

Table 1. Search users action - Inputs
Parameters	Description
SearchTerm	Characters corresponding to a dial keypad if the SearchOption is set to "Keypad" or the actual characters to be searched for if the Search Option is set to "Standard".
SearchOption	Set to "Keypad" to search by digits or "Standard" to search for a match to the actual value.
SearchKey	Indicates the user attribute to be matched. The options are First Name, Last Name, Mobile, and Email.
Limit	The maximum number of users to return.
FilterDuplicateNumbers	Indicates whether to filter out users with the same number or not.
FilterKey	Filter parameter to be sent in the search query and formatted as an Odata filter parameter.

Table 2. Search users action - Outputs
Parameters	Description
Success	Indicates whether the activity was completed successfully (value = True) or not (value = False).
Result	Returns an array with the list of users found.
Count	Returns the number of users found.

↑