Skip to main content

UserFilterInput

Filters that can be applied when listing users

input UserFilterInput {
  birthDate: Date
  firstName: String
  identificationLevel: IdentificationLevelInput
  lastName: String
  mobilePhoneNumber: String
  nationalityCCA3: CCA3
  preferredNotificationChannel: PreferredNotificationChannel
  status: [UserStatus!]
  search: String
}

Fields​

UserFilterInput.birthDate ● Date scalar​

Filter by birth date

UserFilterInput.firstName ● String scalar​

Filter by first name

@deprecated(reason: "use search instead")

UserFilterInput.identificationLevel ● IdentificationLevelInput enum​

Filter by identification level

UserFilterInput.lastName ● String scalar​

Search by last name

@deprecated(reason: "use search instead")

UserFilterInput.mobilePhoneNumber ● String scalar​

Filter by phone number

UserFilterInput.nationalityCCA3 ● CCA3 scalar​

Filter by nationality

UserFilterInput.preferredNotificationChannel ● PreferredNotificationChannel enum​

Filter by preferred notification channel

UserFilterInput.status ● [UserStatus!] list enum​

Filter by status

UserFilterInput.search ● String scalar​

Search string to look for (min length : 3 characters)

Search will be performed in following fields:

  • First name
  • Last name
  • Mobile phone number
  • ID

Member Of​

users query