List Customers (Datagrid)

Returns the paginated, filterable customer list that backs the admin Customers datagrid. The customer's group is returned as a nested group object (id / code / name). The detail-only counters (totalOrders, totalAddresses, totalAmountSpent) resolve only on the single-customer query and are omitted here.

Arguments

All arguments are optional and combine in a single query — filter, sort and paginate together.

Pagination

Argument	Description
first	Number of records to return.
after	Cursor to fetch the page after (from pageInfo.endCursor).

Filters

Each filter narrows the result; supplying more than one combines with logical AND. They mirror the admin Customers datagrid filters.

Argument	Type	Match
name	String	Partial first/last name.
email	String	Partial email.
phone	String	Partial phone.
customer_group_id	Int	Exact group id.
status	Int	0 or 1.
channel_id	Int	Exact channel id.
date_of_birth_from	String	Date of birth ≥ (e.g. "1980-01-01").
date_of_birth_to	String	Date of birth ≤.
created_at_from	String	Registered on ≥.
created_at_to	String	Registered on ≤.

Sorting

Argument	Type	Values
sort	String	id (default), email, first_name
order	String	asc, desc (default desc)

TIP

See the Customers overview for how the menu works.

All admin operations require an admin Bearer token — see Authentication.