CoCoCoCoCoCo / docs
← API reference
Query / commerce

listContacts

List contacts with pagination. Requires contact:list permission.

Arguments

firstInt

Number of items from the start

lastInt

Number of items from the end

afterString

Cursor to start after

beforeString

Cursor to start before

filterContactFilterInput

Filter criteria

sort[ContactSortInput!]

Sort order

Returns ContactConnection!

Scalar fields at a glance

totalCountInt
↗ View the complete ContactConnection type

Explore in a view

Order Intake
View exact SDL
"""List contacts with pagination. Requires contact:list permission."""
listContacts(
  """Number of items from the start"""
  first: Int
  """Number of items from the end"""
  last: Int
  """Cursor to start after"""
  after: String
  """Cursor to start before"""
  before: String
  """Filter criteria"""
  filter: ContactFilterInput
  """Sort order"""
  sort: [ContactSortInput!]
): ContactConnection! @topic(names: ["commerce"])

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