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

Details

type User implements Node, ObjectWithMetadata {
  id: ID!
  privateMetadata: [MetadataItem!]!
  privateMetafield(
    key: String!
  ): String
  privateMetafields(
    keys: [String!]
  ): Metadata
  metadata: [MetadataItem!]!
  metafield(
    key: String!
  ): String
  metafields(
    keys: [String!]
  ): Metadata
  email: String!
  firstName: String!
  lastName: String!
  isStaff: Boolean!
  isActive: Boolean!
  isConfirmed: Boolean!
  addresses: [Address!]!
  checkout: Checkout @deprecated
  checkoutTokens(
    channel: String
  ): [UUID!] @deprecated
  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
    format: ThumbnailFormatEnum = ORIGINAL
  ): Image
  events: [CustomerEvent!]
  storedPaymentSources(
    channel: String
  ): [PaymentSource!]
  languageCode: LanguageCodeEnum!
  defaultShippingAddress: Address
  defaultBillingAddress: Address
  externalReference: String
  lastLogin: DateTime
  dateJoined: DateTime!
  updatedAt: DateTime!
  storedPaymentMethods(
    channel: String!
  ): [StoredPaymentMethod!]
}

Arguments

id ● ID

ID of the user.

email ● String

Email address of the user.

externalReference ● String

External ID of the user.

Type

User

Represents user data.