Search Criteria

A search criterion is an optional element used to restrict the number of entries returned when requesting a potentially large set of data.

A search criterion is composed by 3 parts: 1. sensitive/insensitive: specifies if the query should be case sensitive or insensitive; 2. property: field name to be filtered; 3. search mode: - Starts: the query should match only the entries that start with the input value; - Contains: the query should match only the entries that contain the input value; - Equals: the query should match only the entries that are equal to the input value; 4. value: the input value to be used to filter the entries.

So, for instance, sensitivePhoneNumberStarts=APIO will apply a query for a string starting with value APIO for a case sensitive phone number.

The search can be done using multiple criteria.

If no search criterion is specified, all results will be returned.

Search criteria

The following table provides the list of all the criteria that are supported in the system.

For each specific API you need to look in its own definition to see what criteria are supported for that API.

Name	Type	Method	Description
		GET
combineWithOr	Boolean	O	Combine with OR login when multiple criteria are provided.
sensitiveNameStarts	String	O	Case sensitive name assigned to a phone number starts.
sensitiveNameContains	String	O	Case sensitive name assigned to a phone number contains.
sensitiveNameEquals	String	O	Case sensitive name assigned to a phone number equals.
insensitiveNameStarts	String	O	Case insensitive name assigned to a phone number starts.
insensitiveNameContains	String	O	Case insensitive name assigned to a phone number contains.
insensitiveNameEquals	String	O	Case insensitive name assigned to a phone number equals.
insensitivePhoneNumberStarts	String	O	Case insensitive phone number starts.
insensitivePhoneNumberContains	String	O	Case insensitive phone number contains.
insensitivePhoneNumberEquals	String	O	Case insensitive phone number equals.
sensitiveGroupIdStarts	String	O	Case sensitive group ID starts.
sensitiveGroupIdContains	String	O	Case sensitive group ID contains.
sensitiveGroupIdEquals	String	O	Case sensitive group ID equals.
insensitiveGroupIdStarts	String	O	Case insensitive group ID starts.
insensitiveGroupIdContains	String	O	Case insensitive group ID contains.
insensitiveGroupIdEquals	String	O	Case insensitive group ID equals.
sensitiveGroupNameStarts	String	O	Case sensitive group name starts.
sensitiveGroupNameContains	String	O	Case sensitive group name contains.
sensitiveGroupNameEquals	String	O	Case sensitive group name equals.
insensitiveGroupNameStarts	String	O	Case insensitive group name starts.
insensitiveGroupNameContains	String	O	Case insensitive group name contains.
insensitiveGroupNameEquals	String	O	Case insensitive group name equals.
sensitiveUserIdStarts	String	O	Case sensitive user ID starts.
sensitiveUserIdContains	String	O	Case sensitive user ID contains.
sensitiveUserIdEquals	String	O	Case sensitive user ID equals.
insensitiveUserIdStarts	String	O	Case insensitive user ID starts.
insensitiveUserIdContains	String	O	Case insensitive user ID contains.
insensitiveUserIdEquals	String	O	Case insensitive user ID equals.
insensitiveUserNameStarts	String	O	Case insensitive username starts.
insensitiveUserNameContains	String	O	Case insensitive username contains.
insensitiveUserNameEquals	String	O	Case insensitive username equals.
sensitiveUserLastNameStarts	String	O	Case sensitive user last name starts.
sensitiveUserLastNameContains	String	O	Case sensitive user last name contains.
sensitiveUserLastNameEquals	String	O	Case sensitive user last name equals.
insensitiveUserLastNameStarts	String	O	Case insensitive user last name starts.
insensitiveUserLastNameContains	String	O	Case insensitive user last name contains.
insensitiveUserLastNameEquals	String	O	Case insensitive user last name equals.
sensitiveUserFirstNameStarts	String	O	Case sensitive user first name starts.
sensitiveUserFirstNameContains	String	O	Case sensitive user first name contains.
sensitiveUserFirstNameEquals	String	O	Case sensitive user first name equals.
insensitiveUserFirstNameStarts	String	O	Case insensitive user first name starts.
insensitiveUserFirstNameContains	String	O	Case insensitive user first name contains.
insensitiveUserFirstNameEquals	String	O	Case insensitive user first name equals.
sensitiveYahooIdStarts	String	O	Case sensitive Yahoo ID starts.
sensitiveYahooIdContains	String	O	Case sensitive Yahoo ID contains.
sensitiveYahooIdEquals	String	O	Case sensitive Yahoo ID equals.
insensitiveYahooIdStarts	String	O	Case insensitive Yahoo ID starts.
insensitiveYahooIdContains	String	O	Case insensitive Yahoo ID contains.
insensitiveYahooIdEquals	String	O	Case insensitive Yahoo ID name equals.
sensitiveEmailAddressStarts	String	O	Case sensitive email address starts.
sensitiveEmailAddressContains	String	O	Case sensitive email address contains.
sensitiveEmailAddressEquals	String	O	Case sensitive email address equals.
insensitiveEmailAddressStarts	String	O	Case insensitive email address starts.
insensitiveEmailAddressContains	String	O	Case insensitive email address contains.
insensitiveEmailAddressEquals	String	O	Case insensitive email address equals.
insensitiveExtensionStarts	String	O	Case insensitive extension starts.
insensitiveExtensionContains	String	O	Case insensitive extension contains.
insensitiveExtensionEquals	String	O	Case insensitive extension equals.
sensitiveAlternateTrunkIdentityStarts	String	O	Case sensitive alternate trunk identity starts.
sensitiveAlternateTrunkIdentityContains	String	O	Case sensitive alternate trunk identity contains.
sensitiveAlternateTrunkIdentityEquals	String	O	Case sensitive alternate trunk identity equals.
insensitiveAlternateTrunkIdentityStarts	String	O	Case insensitive alternate trunk identity starts.
insensitiveAlternateTrunkIdentityContains	String	O	Case insensitive alternate trunk identity contains.
insensitiveAlternateTrunkIdentityEquals	String	O	Case insensitive alternate trunk identity equals.
insensitiveUserInTrunkGroupEquals	Boolean	O	Is the user in a trunk group or not.
sensitiveUserGroupEquals	String	O	Case sensitive user group equals.
sensitiveTenantIdEquals	String	O	Case sensitive Tenant equals.
responseSizeLimit	Integer	O	Response size limit for pagination.
includeHiddenUsers	Boolean	O	Include the Hidden Users in the list. Default false. It means end users created in background for the purpose of a feature. Was previously named includeServiceUsers but it was confusing.
sensitiveDeviceServiceProviderIdEquals	String	O	Case sensitive Service Provider equals.
sensitiveDeviceTypeEquals	String	O	Case sensitive Device Type equals.
sensitiveDeviceLevelEquals	String	O	Case sensitive Device Level equals.
sensitiveDeviceGroupIdStarts	String	O	Case sensitive Device Group Id starts.
sensitiveDeviceGroupIdContains	String	O	Case sensitive Device Group Id contains.
sensitiveDeviceGroupIdEquals	String	O	Case sensitive Device Group Id equals.
insensitiveDeviceGroupIdStarts	String	O	Case insensitive Device Group Id starts.
insensitiveDeviceGroupIdContains	String	O	Case insensitive Device Group Id contains.
insensitiveDeviceGroupIdEquals	String	O	Case insensitive Device Group Id equals.
sensitiveDeviceNameStarts	String	O	Case sensitive Device Name starts.
sensitiveDeviceNameContains	String	O	Case sensitive Device Name contains.
sensitiveDeviceNameEquals	String	O	Case sensitive Device Name equals.
insensitiveDeviceNameStarts	String	O	Case insensitive Device Name starts.
insensitiveDeviceNameContains	String	O	Case insensitive Device Name contains.
insensitiveDeviceNameEquals	String	O	Case insensitive Device Name equals.
sensitiveDeviceNetAddressStarts	String	O	Case sensitive Device Net Address starts.
sensitiveDeviceNetAddressContains	String	O	Case sensitive Device Net Address contains.
sensitiveDeviceNetAddressEquals	String	O	Case sensitive Device Net Address equals.
insensitiveDeviceNetAddressStarts	String	O	Case insensitive Device Net Address starts.
insensitiveDeviceNetAddressContains	String	O	Case insensitive Device Net Address contains.
insensitiveDeviceNetAddressEquals	String	O	Case insensitive Device Net Address equals.
sensitiveDeviceMacAddressStarts	String	O	Case sensitive Device Mac Address starts.
sensitiveDeviceMacAddressContains	String	O	Case sensitive Device Mac Address contains.
sensitiveDeviceMacAddressEquals	String	O	Case sensitive Device Mac Address equals.
insensitiveDeviceMacAddressStarts	String	O	Case insensitive Device Mac Address starts.
insensitiveDeviceMacAddressContains	String	O	Case insensitive Device Mac Address contains.
insensitiveDeviceMacAddressEquals	String	O	Case insensitive Device Mac Address equals.
sensitiveGroupLocationCodeStarts	String	O	Case sensitive Group Location Code starts.
sensitiveGroupLocationCodeContains	String	O	Case sensitive Group Location Code contains.
sensitiveGroupLocationCodeEquals	String	O	Case sensitive Group Location Code equals.
insensitiveGroupLocationCodeStarts	String	O	Case insensitive Group Location Code starts.
insensitiveGroupLocationCodeContains	String	O	Case insensitive Group Location Code contains.
insensitiveGroupLocationCodeEquals	String	O	Case insensitive Group Location Code equals.
sensitiveCallTypeEquals	String	O	Case insensitive Call Type equals.
sensitiveDepartmentEquals	Object	O	Object with fields “groupId”, “tenantId”, “departmentName” or “tenantId”, “departmentName” for Tenant Department
insensitiveDigitPatternContains	String	O	Case insensitive Digit Pattern contains.
insensitiveDigitPatternEquals	String	O	Case insensitive Digit Pattern equals.
insensitiveDigitPatternStarts	String	O	Case insensitive Digit Pattern starts.
exactServiceType	String	O	Exact Service Type string. (See Service Type).
insensitiveDnStarts	String	O	Case insensitive phone number starts.
insensitiveDnContains	String	O	Case insensitive phone number contains.
insensitiveDnEquals	String	O	Case insensitive phone number equals.
sensitiveServiceUserIdEquals	String	O	Case sensitive service user ID equals.
backendName	String	O	The name of the backend to be used for a multi-as API call.
backendExternalName	String	O	The external name of the backend to be used for a multi-as API call.
sensitiveAlternateTrunkIdentityDomainStarts	String	O	Case sensitive alternate trunk identity domain starts.
sensitiveAlternateTrunkIdentityDomainContain	String	O	Case sensitive alternate trunk identity domain contains.
sensitiveAlternateTrunkIdentityDomainEquals	String	O	Case sensitive alternate trunk identity domain equals.
insensitiveAlternateTrunkIdentityDomainStarts	String	O	Case insensitive alternate trunk identity domain starts.
insensitiveAlternateTrunkIdentityDomainContain	String	O	Case insensitive alternate trunk identity domain contains.
insensitiveAlternateTrunkIdentityDomainEquals	String	O	Case insensitive alternate trunk identity domain equals.
sensitiveTrunkGroupNameStarts	String	O	Case sensitive trunk group name starts.
sensitiveTrunkGroupNameContains	String	O	Case sensitive trunk group name contains.
sensitiveTrunkGroupNameEquals	String	O	Case sensitive trunk group name equals.
insensitiveTrunkGroupNameStarts	String	O	Case insensitive trunk group name starts.
insensitiveTrunkGroupNameContains	String	O	Case insensitive trunk group name contains.
insensitiveTrunkGroupNameEquals	String	O	Case insensitive trunk group name equals.
insensitiveExternalId1Equals	String	O	Case insensitive external id 1 equals.
insensitiveExternalId1Contains	String	O	Case insensitive external id 1 contains.
insensitiveExternalId1Starts	String	O	Case insensitive external id 1 starts.
insensitiveExternalId2Equals	String	O	Case insensitive external id 2 equals.
insensitiveExternalId2Contains	String	O	Case insensitive external id 2 contains.
insensitiveExternalId2Starts	String	O	Case insensitive external id 2 starts.
insensitiveExternalId3Equals	String	O	Case insensitive external id 3 equals.
insensitiveExternalId3Contains	String	O	Case insensitive external id 3 contains.
insensitiveExternalId3Starts	String	O	Case insensitive external id 3 starts.
insensitiveExternalId4Equals	String	O	Case insensitive external id 4 equals.
insensitiveExternalId4Contains	String	O	Case insensitive external id 4 contains.
insensitiveExternalId4Starts	String	O	Case insensitive external id 4 starts.
insensitiveResellerIdEquals	String	O	Case insensitive reseller id equals.
sensitiveServiceInstanceNameStarts	String	O	Case sensitive Service Instance Name starts.
sensitiveServiceInstanceNameContains	String	O	Case sensitive Service Instance Name contains.
sensitiveServiceInstanceNameEquals	String	O	Case sensitive Service Instance Name equals.
insensitiveServiceInstanceNameStarts	String	O	Case insensitive Service Instance Name starts.
insensitiveServiceInstanceNameContains	String	O	Case insensitive Service Instance Name contains.
insensitiveServiceInstanceNameEquals	String	O	Case insensitive Service Instance Name equals.