---
title: User - Shop Partners API
description: |-
  The authenticated user. Fields are gated by the access token's granted scopes;
  fields not granted by the token resolve to `null`.
api_version: unstable latest
source_url:
  html: https://shopify.dev/docs/api/shop-partners/latest/objects/User
  md: https://shopify.dev/docs/api/shop-partners/latest/objects/User.md
---

# User

object

The authenticated user. Fields are gated by the access token's granted scopes; fields not granted by the token resolve to `null`.

## Fields

* avatar

  [String](https://shopify.dev/docs/api/shop-partners/latest/scalars/String)

  URL of the user's avatar image. Requires the `avatar` or `profile` scope.

* email

  [String](https://shopify.dev/docs/api/shop-partners/latest/scalars/String)

  The user's email address. Requires `email` (also granted by `email:verified` or `user:manage`).

* email​Verified

  [Boolean](https://shopify.dev/docs/api/shop-partners/latest/scalars/Boolean)

  Whether the user's email has been verified. Requires `email` (also granted by `email:verified` or `user:manage`).

* family​Name

  [String](https://shopify.dev/docs/api/shop-partners/latest/scalars/String)

  The user's family (last) name. Requires the `name` or `profile` scope.

* given​Name

  [String](https://shopify.dev/docs/api/shop-partners/latest/scalars/String)

  The user's given (first) name. Requires the `name` or `profile` scope.

* name

  [String](https://shopify.dev/docs/api/shop-partners/latest/scalars/String)

  The user's full name (given + family). Requires the `name` or `profile` scope.

* phone

  [String](https://shopify.dev/docs/api/shop-partners/latest/scalars/String)

  The user's phone number. Requires `phone` (also granted by `phone:verified` or `user:manage`). Returns `null` if the user has no phone on record.

* phone​Verified

  [Boolean](https://shopify.dev/docs/api/shop-partners/latest/scalars/Boolean)

  Whether the user's phone number has been verified. Requires `phone` (also granted by `phone:verified` or `user:manage`). Returns `null` if the user has no phone on record.

* sub

  [String](https://shopify.dev/docs/api/shop-partners/latest/scalars/String)

  Stable subject identifier of the user. Always present when the token authenticates a user; not gated by a specific scope.

***

## Map

No referencing types

***

## Mutations

* [fetch​Tokens​For​User](https://shopify.dev/docs/api/shop-partners/latest/mutations/fetchTokensForUser)

  mutation

  Fetch an OAuth Access and Refresh Token pair for a user. Exactly one of `publicId` or `consentToken` must be provided.

  When `publicId` is provided, the user's existing connection with the client is verified and tokens are issued for the consented scope.

  When `consentToken` is provided — a signed JWT from a Sign in with Shop flow granting delegated consent from a merchant's buyer connection to this partner — the token is verified, a delegated user connection is established, and tokens are issued for the delegated scope.

  * consent​Token

    [String](https://shopify.dev/docs/api/shop-partners/latest/scalars/String)

    ### Arguments

    Signed JWT consent token from a Sign in with Shop flow granting delegated access. Required when not providing a public ID.

  * public​Id

    [String](https://shopify.dev/docs/api/shop-partners/latest/scalars/String)

    The public ID of the user. Required when not providing a consent token.

  ***

***

## User Mutations

### Mutated by

* [fetch​Tokens​For​User](https://shopify.dev/docs/api/shop-partners/latest/mutations/fetchTokensForUser)