List Customers

Retrieves a paginated list of customers with optional filtering and sorting.

Query

query ListCustomers(
  $filter: CustomerFilter
  $paging: CursorPaging
  $sorting: [CustomerSort!]
) {
  customers(filter: $filter, paging: $paging, sorting: $sorting) {
    edges {
      node {
        customerId
        name
        email
        hasActiveSubscription
        createdAt
        subscriptions {
          subscriptionId
          status
          plan {
            refId
          }
        }
      }
      cursor
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    totalCount
  }
}

Parameters

filter

CustomerFilter

Filter criteria for customers

Show properties

customerId

StringFieldComparison

Filter by customer ID (eq, in, like, etc.)

name

StringFieldComparison

Filter by customer name

StringFieldComparison

Filter by email address

billingId

StringFieldComparison

Filter by billing provider ID

createdAt

DateFieldComparison

Filter by creation date

searchQuery

CustomerSearchQueryFilterComparison

Full-text search across customer fields

subscriptions

CustomerFilterCustomerSubscriptionFilter

Filter by subscription properties

and

[CustomerFilter]

Combine multiple filters with AND logic

[CustomerFilter]

Combine multiple filters with OR logic

paging

CursorPaging

Pagination options

Show properties

first

Int

Number of items to fetch (forward pagination)

after

String

Cursor to fetch items after

last

Int

Number of items to fetch (backward pagination)

before

String

Cursor to fetch items before

sorting

[CustomerSort]

Sorting options

Show properties

field

CustomerSortFields

required

Field to sort by: createdAt, updatedAt, customerId, name, email

direction

SortDirection

required

Sort direction: ASC or DESC

Return Type

Returns a CustomerConnection with:

Field	Type	Description
`edges`	[CustomerEdge]	List of customer edges
`edges.node`	Customer	The customer object
`edges.cursor`	String	Cursor for pagination
`pageInfo`	PageInfo	Pagination metadata
`totalCount`	Int	Total number of matching customers

Filter Examples

Find customers by email domain

{
  "filter": {
    "email": { "like": "%@acme.com" }
  }
}

Find customers created this month

{
  "filter": {
    "createdAt": { "gte": "2024-01-01T00:00:00Z" }
  }
}

Find customers with specific subscription status

{
  "filter": {
    "subscriptions": {
      "status": { "eq": "ACTIVE" }
    }
  }
}

Full-text search

{
  "filter": {
    "searchQuery": { "like": "acme" }
  }
}

Common Use Cases

Admin dashboard

Display paginated list of customers with search and filtering capabilities.

Export customers

Iterate through all customers using pagination for data export.

Find customers by plan

Filter customers subscribed to a specific plan.

Get Customer - Get single customer by ID
Provision Customer - Create new customer

Overview

Queries

Mutations

Types

Backend SDKs

Frontend SDKs

List Customers

Query

Parameters

Return Type

Filter Examples

Find customers by email domain

Find customers created this month

Find customers with specific subscription status

Full-text search

Common Use Cases

Overview

Queries

Mutations

Types

Backend SDKs

Frontend SDKs

​Query

​Parameters

​Return Type

​Filter Examples

​Find customers by email domain

​Find customers created this month

​Find customers with specific subscription status

​Full-text search

​Common Use Cases

​Related Operations

Query

Parameters

Return Type

Filter Examples

Find customers by email domain

Find customers created this month

Find customers with specific subscription status

Full-text search

Common Use Cases

Related Operations