Choose a version:

customer

query

The customer associated with the given access token. Tokens are obtained by using the customerAccessTokenCreate mutation.

Anchor to Arguments

Arguments

Anchor to customerAccessTokencustomerAccessToken •String! required: The customer access token.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to CustomerCustomer

•Customer

A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout.

Anchor to acceptsMarketingacceptsMarketing

•Boolean!

non-null

Indicates whether the customer has consented to be sent marketing material via email.

Anchor to addressesaddresses

•MailingAddressConnection!

non-null

A list of addresses for the customer.

Anchor to firstfirst •Int: Returns up to the first n elements from the list.
Anchor to afterafter •String: Returns the elements that come after the specified cursor.
Anchor to lastlast •Int: Returns up to the last n elements from the list.
Anchor to beforebefore •String: Returns the elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to avatarUrlavatarUrl

•String

The URL of the customer's avatar image.

Anchor to createdAtcreatedAt

•DateTime!

non-null

The date and time when the customer was created.

Anchor to defaultAddressdefaultAddress

•MailingAddress

The customer’s default address.

Anchor to displayNamedisplayName

•String!

non-null

The customer’s name, email or phone number.

Anchor to emailemail

•String

The customer’s email address.

Anchor to firstNamefirstName

•String

The customer’s first name.

Anchor to idid

•ID!

non-null

A unique ID for the customer.

Anchor to lastNamelastName

•String

The customer’s last name.

Anchor to metafieldmetafield

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The identifier for the metafield.

Anchor to metafieldsmetafields

•[Metafield]!

non-null

A list of custom fields that a merchant associates with a Shopify resource.

Arguments

Anchor to identifiersidentifiers

•[HasMetafieldsIdentifier!]!

required

The list of metafields to retrieve by namespace and key.

The input must not contain more than 250 values.

Anchor to numberOfOrdersnumberOfOrders

•UnsignedInt64!

non-null

The number of orders that the customer has made at the store in their lifetime.

Anchor to ordersorders

•OrderConnection!

non-null

The orders associated with the customer.

Arguments

Anchor to firstfirst

•Int

Returns up to the first n elements from the list.

Anchor to afterafter

•String

Returns the elements that come after the specified cursor.

Anchor to lastlast

•Int

Returns up to the last n elements from the list.

Anchor to beforebefore

•String

Returns the elements that come before the specified cursor.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•OrderSortKeys

Default:ID

Sort the underlying list by the given key.

Anchor to queryquery

•String

Apply one or multiple filters to the query. Refer to the detailed search syntax for more information about using filters.

Anchor to processed_at •

Anchor to phonephone

•String

The customer’s phone number.

Anchor to socialLoginProvidersocialLoginProvider

•SocialLoginProvider

The social login provider associated with the customer.

Anchor to tagstags

•[String!]!

non-null

A comma separated list of tags that have been added to the customer. Additional access scope required: unauthenticated_read_customer_tags.

Anchor to updatedAtupdatedAt

•DateTime!

non-null

The date and time when the customer information was updated.

Was this section helpful?

Examples

Get a customer by access token

Description

The following query retrieves the customer with the associated access token. It returns the customer fields specified in the query.

Query

query {
  customer(customerAccessToken: "bobs_token") {
    id
    firstName
    lastName
    acceptsMarketing
    email
    phone
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \
-d '{
"query": "query { customer(customerAccessToken: \"bobs_token\") { id firstName lastName acceptsMarketing email phone } }"
}'

React Router

import { unauthenticated } from "../shopify.server";

export const loader = async () => {
  const { storefront } = await unauthenticated.storefront(
    'your-development-store.myshopify.com'
  );
  const response = await storefront.graphql(
    `#graphql
  query {
    customer(customerAccessToken: "bobs_token") {
      id
      firstName
      lastName
      acceptsMarketing
      email
      phone
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Storefront({
  domain: 'your-development-store.myshopify.com',
  storefrontAccessToken,
});
const data = await client.query({
  data: `query {
    customer(customerAccessToken: "bobs_token") {
      id
      firstName
      lastName
      acceptsMarketing
      email
      phone
    }
  }`,
});

Response

{
  "customer": {
    "id": "gid://shopify/Customer/410535040",
    "firstName": "John",
    "lastName": "Smith",
    "acceptsMarketing": false,
    "email": "johnsmith@example.com",
    "phone": "+16134504533"
  }
}

Get a customer by access token

Open in GraphiQL

import { unauthenticated } from "../shopify.server";

export const loader = async () => {

const { storefront } = await unauthenticated.storefront(

'your-development-store.myshopify.com'

);

const response = await storefront.graphql(

`#graphql

query {

customer(customerAccessToken: "bobs_token") {

firstName

lastName

acceptsMarketing

phone

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query {
  customer(customerAccessToken: "bobs_token") {
    id
    firstName
    lastName
    acceptsMarketing
    email
    phone
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \
-d '{
"query": "query { customer(customerAccessToken: \"bobs_token\") { id firstName lastName acceptsMarketing email phone } }"
}'

React Router

import { unauthenticated } from "../shopify.server";

export const loader = async () => {
  const { storefront } = await unauthenticated.storefront(
    'your-development-store.myshopify.com'
  );
  const response = await storefront.graphql(
    `#graphql
  query {
    customer(customerAccessToken: "bobs_token") {
      id
      firstName
      lastName
      acceptsMarketing
      email
      phone
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Storefront({
  domain: 'your-development-store.myshopify.com',
  storefrontAccessToken,
});
const data = await client.query({
  data: `query {
    customer(customerAccessToken: "bobs_token") {
      id
      firstName
      lastName
      acceptsMarketing
      email
      phone
    }
  }`,
});

Response

JSON

{

"customer": {

"id": "gid://shopify/Customer/410535040",

"firstName": "John",

"lastName": "Smith",

"acceptsMarketing": false,

"email": "johnsmith@example.com",

"phone": "+16134504533"

}