Choose a version:

customersCount

query

Requires read_customers access scope.

The number of customers. Limited to a maximum of 10000 by default.

Anchor to Arguments

Arguments

Anchor to limitlimit

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to queryquery

•String

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

A numeric count with precision information indicating whether the count is exact or an estimate.

Anchor to countcount

•Int!

non-null

The count of elements.

Anchor to precisionprecision

•CountPrecision!

non-null

The count's precision, or the exactness of the value.

Was this section helpful?

Examples

Retrieves a count of customers

Description

Retrieve the total number of customers

Query

query CustomerCount {
  customersCount {
    count
  }
}

cURL

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

React Router

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

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query CustomerCount {
    customersCount {
      count
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

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)

Node.js

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

Response

{
  "customersCount": {
    "count": 20
  }
}

Retrieves a count of customers

Open in GraphiQL

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

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

query CustomerCount {

customersCount {

count

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query CustomerCount {
  customersCount {
    count
  }
}

cURL

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

React Router

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

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query CustomerCount {
    customersCount {
      count
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

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

Ruby

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

}