CoCoCoCoCoCo / docs
← API reference
Query / commerce

listCustomers

List customers with pagination, filtering, and sorting. Requires customer:list permission.

Arguments

firstInt

Number of items to return from the start (forward pagination)

lastInt

Number of items to return from the end (backward pagination)

afterString

Cursor pointing to the item after which to start

beforeString

Cursor pointing to the item before which to start

filterCustomerFilterInput

Filter criteria for customers

sort[CustomerSortInput!]

Sort order for results

Returns CustomerConnection!

Scalar fields at a glance

totalCountInt
↗ View the complete CustomerConnection type

Explore in a view

Order Intake
View exact SDL
"""
List customers with pagination, filtering, and sorting. Requires customer:list permission.
"""
listCustomers(
  """Number of items to return from the start (forward pagination)"""
  first: Int
  """Number of items to return from the end (backward pagination)"""
  last: Int
  """Cursor pointing to the item after which to start"""
  after: String
  """Cursor pointing to the item before which to start"""
  before: String
  """Filter criteria for customers"""
  filter: CustomerFilterInput
  """Sort order for results"""
  sort: [CustomerSortInput!]
): CustomerConnection! @topic(names: ["commerce"])

Schema reference describes the API contract. Actual access is checked by the platform for every operation.