Contacts API: Supported Filters and Sorting

Fields supported by Query Contacts

The following table shows field support for filters and sorting for the Query Contacts method:

Field	Supported filters	Sortable
id	$eq, $in
createdDate	$eq, $gt, $lt, $gte, $lte	Sortable
updatedDate	$eq, $gt, $lt, $gte, $lte	Sortable
email.email	$eq, $in, $exists
phone.phone	$eq, $in, $exists
externalId	$eq, $in, $exists

Methods that use the search object

The following table shows field support for filters, sorting, and search for methods that use the search object:

• Search Contacts
• Count Contacts
• Bulk Update Contact Tags By Filter
• Bulk Delete Contacts By Filter
• Bulk Update Phone Country Code By Filter

Field	Supported filters	Sortable	Searchable
id	$eq, $ne, $in, $nin
createdDate	$eq, $ne, $gt, $lt, $gte, $lte	Sortable
updatedDate	$eq, $ne, $gt, $lt, $gte, $lte	Sortable
email.email	$eq, $ne, $in, $nin, $exists, $begins	Sortable	Searchable
phone.phone	$eq, $ne, $in, $nin, $exists, $begins	Sortable	Searchable
phone.e164	$eq, $ne, $in, $nin, $exists, $begins
externalId	$eq, $in, $exists
source.userId	$eq, $ne, $in, $nin, $exists
source.appId	$eq, $ne, $in, $nin, $exists
source.additionalInfo	$eq, $ne, $in, $nin, $exists, $begins
assigneeId	$eq, $ne, $in, $nin, $exists
timeZone	$eq, $ne, $in, $nin, $exists
locale	$eq, $ne, $in, $nin, $exists, $begins
birthdate	$eq, $ne, $gt, $lt, $gte, $lte	Sortable
name.first	$eq, $ne, $in, $nin, $exists, $begins	Sortable
name.last	$eq, $ne, $in, $nin, $exists, $begins	Sortable
name.full			Searchable
company.name	$eq, $ne, $in, $nin, $exists, $begins	Sortable	Searchable
company.jobTitle	$eq, $ne, $in, $nin, $exists, $begins	Sortable	Searchable
email.subscriptionStatus.status	$eq, $ne, $in, $nin
email.deliverabilityStatus	$eq, $ne, $in, $nin
phone.subscriptionStatus.status	$eq, $ne, $in, $nin
phone.deliverabilityStatus	$eq, $ne, $in, $nin
locationIds	$hasSome, $hasAll, $empty, $exists
segmentIds	$hasSome, $hasAll, $empty, $exists
tags.privateTags.tagIds	$hasSome, $hasAll, $empty, $exists
lastActivity.date	$eq, $ne, $gt, $lt, $gte, $lte	Sortable
memberInfo.memberId	$eq, $ne, $in, $nin, $exists
memberInfo.status	$eq, $ne, $in, $nin, $exists	Sortable
memberInfo.email	$eq, $ne, $in, $nin, $exists, $begins	Sortable	Searchable
memberInfo.emailVerified	$eq, $ne
memberInfo.emailVerificationRequired	$eq, $ne
memberInfo.signupDate	$eq, $ne, $gt, $lt, $gte, $lte	Sortable
memberInfo.profileInfo.nickname	$eq, $ne, $in, $nin, $exists, $begins	Sortable	Searchable
memberInfo.profileInfo.privacyStatus	$eq, $ne, $in, $nin, $exists	Sortable
memberInfo.profileInfo.reported	$eq, $ne
memberInfo.profileInfo.muted	$eq, $ne
memberInfo.userInfo.role	$eq, $ne, $in, $nin, $exists	Sortable
memberInfo.sessionInfo.lastWebLogin	$eq, $ne, $gt, $lt, $gte, $lte	Sortable
memberInfo.sessionInfo.lastMobileLogin	$eq, $ne, $gt, $lt, $gte, $lte	Sortable
memberInfo.sessionInfo.mobileAppNames	$hasSome, $hasAll, $empty, $exists
memberInfo.groupInfo.groupIds	$hasSome, $hasAll, $empty, $exists
additionalEmails.email	$hasSome, $hasAll, $exists, $begins
additionalPhones.phone	$hasSome, $hasAll, $exists, $begins
additionalPhones.e164	$hasSome, $hasAll, $exists, $begins
addresses.address.country	$hasSome, $hasAll, $exists
addresses.address.subdivision	$hasSome, $hasAll, $exists
addresses.address.city	$hasSome, $hasAll, $exists, $begins
addresses.address.postalCode	$hasSome, $hasAll, $exists, $begins
addresses.address.addressLine	$hasSome, $hasAll, $exists, $begins
addresses.address.streetAddress.name	$hasSome, $hasAll, $exists, $begins
addresses.address.subdivisionFullname	$hasSome, $hasAll, $exists, $begins
addresses.recipient.firstName	$hasSome, $hasAll, $exists, $begins
addresses.recipient.lastName	$hasSome, $hasAll, $exists, $begins
addresses.recipient.company	$hasSome, $hasAll, $exists, $begins
addresses.recipient.phone	$hasSome, $hasAll, $exists

Related content:

• API Query Language