customersCount

query

Requires read_customers access scope.

The number of customers.

Arguments

query

•

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to created_at • time
Anchor to id • id: Filter by id range.
Anchor to updated_at • time

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to CountCount • Count: Details for count of elements.

Was this section helpful?

Retrieves a count of customers

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query CustomerCount {

customersCount {

count

}

}`,

);

const data = await response.json();

query CustomerCount {
  customersCount {
    count
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query CustomerCount { customersCount { count } }"
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query CustomerCount {
    customersCount {
      count
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query CustomerCount {
    customersCount {
      count
    }
  }`,
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query CustomerCount {
    customersCount {
      count
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"customersCount": {

"count": 20

}