Search User Profiles by Text.

User will get a list of User Profiles matching the searchText in response. Provided searchText will be matched against the user attributes case insensitively - First Name, Last Name, Friendly Name, Email, Phone, Company, Contact, Country, Group Names, and Role Name. User will only see the list of users that are part of the user groups that it belongs to.

SecurityApiKeyAuth or BasicAuth
Request
path Parameters
searchText
required
string

Specify searchText to search across user attributes.

header Parameters
X-API-Key
required
string

Customer-specific API key required to invoke API.

Authorization
required
string

Provided by Authentication Token creation operation

AccessToken
required
string

JWT token provided by Authentication Token creation operation.

Responses
200

The Response Body will be a JSON object

401

Unauthorized. Missing Authorization or AccessToken or Access Token expired

403

Forbidden. Missing X-API-key

get/user/search/{searchText}
Request samples 
Response samples 
application/json
{
  • "status": "success",
  • "data": [
    ]
}