Shopify.devDocs
Log inSign up

Shopify uses cookies to provide necessary site functionality and improve your experience. By using our website, you agree to our privacy policy and our cookie policy.

Anchor to customers

customers

query

Returns a list of customers.

Anchor to Arguments

CustomerConnection arguments

•CustomerConnection!
Anchor to afterafter
•
String

The elements that come after the specified cursor.

Anchor to beforebefore
•
String

The elements that come before the specified cursor.

Anchor to firstfirst
•
Int

The first n elements from the paginated list.

Anchor to lastlast
•
Int

The last n elements from the paginated list.

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 default
•
string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman

  • query=title:green hoodie

Anchor to email
•
string

The customer's email address, used to communicate information about orders and for the purposes of email marketing campaigns. You can use a wildcard value to filter the query by customers who have an email address specified.

Example:

  • email:bo.wang@example.com

  • email:*

Anchor to id
•
id

Filter by id range.

Example:

  • id:1234

  • id:>=1234

  • id:<=1234

Anchor to phone
•
string

The phone number of the customer, used to communicate information about orders and for the purposes of SMS marketing campaigns. You can use a wildcard value to filter the query by customers who have a phone number specified.

Example:

  • phone:+18005550100

  • phone:*

Anchor to updated_at
•
time

The date and time, matching a whole day, when the customer's information was last updated.

Example:

  • updated_at:2024-01-01T00:00:00Z

  • updated_at:<now

  • updated_at:<=2024

Anchor to reversereverse
•
BooleanDefault:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•
CustomerSortKeysDefault:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges
•
[CustomerEdge!]!non-null

The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.

Anchor to nodesnodes
•
[Customer!]!non-null

A list of nodes that are contained in CustomerEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.

Anchor to pageInfopageInfo
•
PageInfo!non-null

An object that’s used to retrieve cursor information about the current page.

Was this section helpful?