This documentation supports the 20.08 version of BMC Helix Platform.  To view an earlier version, select 20.02 from the Product version menu.

Get person details by using search criteria


The get card by search text method enables you to fetch the contact details of any person that matches the search criteria. The person can be an employee, agent, customer, or vendor. The method can also be used with various INCLUDE parameter to fetch additional details of the persons.

URLs

The following table provides information about the URLs used to fetch the person details:

Parameter

The following table provides information about the parameter of the get card by search text method:

Example

To get all the contact details of agent persons along with their thumbnails and details of support groups they are a member of, use the following URL:

/api/com.bmc.arsys.rx.foundation/person/cards?queryExpression='personSelection' LIKE "Agent"&include=thumbnail,memberSupportGroups&pageSize=30&sortBy=fullName

Related topics

Get-person-details

Get-person-details-by-using-person-ID

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*