• Products
  • Get started
  • Documentation
  • Resources

Search syntax for users

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 Name

Description

Example

id

Universally unique identifier of the user as string

id: b9a2fb13-1b76-4b41-be28-eed2c61978fa

blocked

Boolean flag that shows if a user is blocked due to a subscription update.
Available values are true and false

blocked: false

username

Login e-mail of the user as string

username: neo@opsgenie.com

verified

Boolean flag that shows if a user is verified.
Available values are true and false

verified: true

responder

Boolean 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

role

Name of the role (no matter default or custom role) as string that is assigned to a user

role: Admin

fullName

The combination of the name and the surname of a user as string

fullName: "Kadir Türker Gülsoy"

timezone

Time zone of the user string. You can refer Supported Timezone IDs to see the possible values.

timezone: "America/New_York"

locale

Locale of the user as string. You can refer Supported Locale IDs to see the possible values.

locale: "en_US"

muteUntil

UTC 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"

createdAt

UTC 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"

updatedAt

UTC 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"

skypeUsername

Skype username of the user as string.

skypeUsername: phoenix

tag

Tag 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.country

Country of the user as string

address.country: "United States of America"

address.state

State (Address) of the user as string

address.state: California

address.city

City of the user as string

address.city: "San Francisco"

address.line

Address line of the user as string

address.line: "2166 Foxworthy Ave"

address.zipCode

ZIP 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

Operator

Description

()

Will match more than one character.

?

Will match just one character.

 

Additional Help