Skip to content
Saleor
Esc
↑↓navigate↵open⌘Jpreview

Schema: Saleor 3.23.43Download SDLUpgrade guides

On this page

user Query

Look up a user by ID or email address.

Requires one of the following permissions:MANAGE_STAFFMANAGE_USERSMANAGE_ORDERS
user(id: ID, email: String, externalReference: String): User

Returns

User

Show return type
type User implements Node & ObjectWithMetadata & ObjectWithAttributes {
  id: ID!
  privateMetadata: [MetadataItem!]!
  privateMetafield(key: String!): String
  privateMetafields(keys: [String!]): Metadata
  metadata: [MetadataItem!]!
  metafield(key: String!): String
  metafields(keys: [String!]): Metadata
  assignedAttribute(slug: String!): AssignedAttribute
  assignedAttributes(limit: PositiveInt = 100): [AssignedAttribute!]!
  email: String!
  firstName: String!
  lastName: String!
  isStaff: Boolean!
  isActive: Boolean!
  isConfirmed: Boolean!
  addresses: [Address!]!
  checkout: Checkout @deprecated(reason: "Use the `checkoutTokens` field to fetch the user checkouts.")
  checkoutTokens(channel: String): [UUID!] @deprecated(reason: "Use `checkoutIds` instead.")
  checkoutIds(channel: String): [ID!]
  checkouts(channel: String, before: String, after: String, first: Int, last: Int): CheckoutCountableConnection
  giftCards(before: String, after: String, first: Int, last: Int): GiftCardCountableConnection
  note: String
  orders(where: CustomerOrderWhereInput, before: String, after: String, first: Int, last: Int): OrderCountableConnection
  userPermissions: [UserPermission!]
  permissionGroups: [Group!]
  editableGroups: [Group!]
  accessibleChannels: [Channel!]
  restrictedAccessToChannels: Boolean!
  avatar(size: Int, sizeRounding: ThumbnailSizeRoundingEnum = NEAREST, format: ThumbnailFormatEnum = ORIGINAL): Image
  events: [CustomerEvent!]
  storedPaymentSources(channel: String): [PaymentSource!] @deprecated(reason: "The legacy Payments API is deprecated and will be removed. Use the Transactions API instead.")
  languageCode: LanguageCodeEnum!
  defaultShippingAddress: Address
  defaultBillingAddress: Address
  externalReference: String
  customerType: CustomerType
  lastLogin: DateTime
  dateJoined: DateTime!
  updatedAt: DateTime!
  storedPaymentMethods(channel: String!): [StoredPaymentMethod!]
}

Arguments

id

id · ID

ID of the user.

email

email · String

Email address of the user.

externalReference

externalReference · String

External ID of the user.


Schema: Saleor 3.23.43. Download SDL.

Last updated on August 10, 2026

Was this page helpful?