Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1438230222.0 KB

Searches for profiles within a specific domain using one or more predefined search keys (e.g., _fullName, _phone, _email, _account, etc.) and/or custom-defined search keys. A search key is a data type pair that consists of a KeyName and Values list.

This operation supports searching for profiles with a minimum of 1 key-value(s) pair and up to 5 key-value(s) pairs using either AND or OR logic.

post/domains/{DomainName}/profiles/search

Path parameters

DomainNamestring required

The unique name of the domain.

Query parameters

next-tokenstring

The pagination token from the previous SearchProfiles API call.

max-resultsinteger
<p>The maximum number of objects returned per page.</p> <p>The default is 20 if this parameter is not included in the request.</p>

Request body

KeyNamestring required

A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.

ValuesString1To255[] required

A list of key values.

LogicalOperator'AND' | 'OR'
<p>Relationship between all specified search keys that will be used to search for profiles. This includes the required <code>KeyName</code> and <code>Values</code> parameters as well as any key-value(s) pairs specified in the <code>AdditionalSearchKeys</code> list.</p> <p>This parameter influences which profiles will be returned in the response in the following manner:</p> <ul> <li> <p> <code>AND</code> - The response only includes profiles that match all of the search keys.</p> </li> <li> <p> <code>OR</code> - The response includes profiles that match at least one of the search keys.</p> </li> </ul> <p>The <code>OR</code> relationship is the default behavior if this parameter is not included in the request.</p>

Response

Success

NextTokenstring

The pagination token from the previous SearchProfiles API call.