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 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 false
blocked: 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 false
verified: true
responderBoolean flag that shows if a user has either a default role excepting Observer or a custom role that is extended from a default role excepting Observer.
Available values are true and false
responder: true
roleName of the role (no matter default or custom role) as string that is 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 string. You can refer Supported Timezone IDs to see the possible values.timezone: "America/New_York"
localeLocale of the user as string. You can refer Supported Locale IDs to see the possible values.locale: "en_US"
muteUntilUTC Timestamp that the user is muted until. There are two options for the format of the value:
-Epoch Milliseconds
-ISO 8061 Date and Time Format
muteUntil: 1470394841148
muteUntil: "2017-04-03T20:05:50.894Z"
createdAtUTC Timestamp that the user was created at. There are two options for the format of the value:
-Epoch Milliseconds
-ISO 8061 Date and Time Format
createdAt: 1470394841148
createdAt: "2017-04-03T20:05:50.894Z"
updatedAtUTC Timestamp that the user was updated last. There are two options for the format of the value:
-Epoch Milliseconds
-ISO 8061 Date and Time Format
updatedAt: 1470394841148
updatedAt: "2017-04-03T20:05:50.894Z"
skypeUsernameSkype username of the user as string.skypeUsername: phoenix
tagTag of the user as string. When a value is specified, users are matched only if at least one of their tags satisfy 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 users' address as string.address.zipCode: 94016
details.Value of the custom property of the user for the given key.

The key can be any string value. E.g. "this is: a key".
details.externalState: Created

details."this is a key": "long property value"

Wildcards

OperatorDescription
(:star:)Will match more than one character.
?Will match just one character.

Updated 8 months ago


User Search Queries


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

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.