User Search Queries

Refer to this table for the available fields for user search queries, which differ from the alert search queries.

The key-value syntax, the condition operators, and the logical operators of the user search queries are the same as alert search queries. However, available fields to include in the queries differ from the Alerts Search Query Help queries as expected.

Field Descriptions

Field NameDescriptionExample
idUniversally unique identifier of the user as stringid: b9a2fb13-1b76-4b41-be28-eed2c61978fa
blockedBoolean flag that shows if a user is blocked due to a subscription update. Available values are true and falseblocked: false
usernameLogin e-mail of the user as stringusername: [email protected]
verifiedBoolean flag that shows if a user is verified. Available values are true and falseverified: true
responderBoolean flag that shows if a user has either a default role excepting Observer or a custom role extended from a default role excepting Observer. Available values are true and falseresponder: true
roleName of the role (default or custom) as string assigned to a userrole: Admin
fullNameThe combination of the name and the surname of a user as stringfullName: "Kadir Türker Gülsoy"
timezoneTime zone of the user as string. Refer to Supported Timezone IDs for possible values.timezone: "America/New_York"
localeLocale of the user as string. Refer to Supported Locale IDs for possible values.locale: "en_US"
muteUntilUTC Timestamp that the user is muted until. Format options: Epoch Milliseconds or ISO 8061 Date and Time FormatmuteUntil: 1470394841148 or muteUntil: "2017-04-03T20:05:50.894Z"
createdAtUTC Timestamp when the user was created. Format options: Epoch Milliseconds or ISO 8061 Date and Time FormatcreatedAt: 1470394841148 or createdAt: "2017-04-03T20:05:50.894Z"
updatedAtUTC Timestamp when the user was last updated. Format options: Epoch Milliseconds or ISO 8061 Date and Time FormatupdatedAt: 1470394841148 or updatedAt: "2017-04-03T20:05:50.894Z"
skypeUsernameSkype username of the user as stringskypeUsername: phoenix
tagTag of the user as string. Users are matched only if at least one of their tags satisfies the given field-value condition.tag: Financier
address.countryCountry of the user as stringaddress.country: "United States of America"
address.stateState (Address) of the user as stringaddress.state: California
address.cityCity of the user as stringaddress.city: "San Francisco"
address.lineAddress line of the user as stringaddress.line: "2166 Foxworthy Ave"
address.zipCodeZIP Code of the user's address as stringaddress.zipCode: 94016
details.<key>Value of the custom property of the user for the given key. The key can be any string value.details.externalState: Created or details."this is a key": "long property value"

Wildcards

OperatorDescription
*Will match more than one character.
?Will match just one character.