> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.qonversion.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List customers

> Returns a paginated list of customers for the authenticated project.
Manifest-compliant: list envelope, ISO 8601 timestamps.




## OpenAPI

````yaml /api-reference/rest-api-v4.yaml get /customers
openapi: 3.0.3
info:
  title: Qonversion REST API v4
  version: '4.0'
  description: >-
    Qonversion REST API v4 follows REST standards. It has predictable
    resource-oriented URLs, accepts JSON-encoded request bodies, returns
    JSON-encoded responses, and uses standard HTTP response codes,
    authentication, and verbs.
servers:
  - url: https://api.qonversion.io/v4
    description: Production
security:
  - secretAuth: []
tags:
  - name: Users
    description: Retrieve Qonversion users
  - name: User Properties
    description: Manage user-level attributes
  - name: Identities
    description: Link Qonversion users to your own auth IDs
  - name: Entitlements
    description: Entitlement definitions and user grants
  - name: Purchases
    description: A user's purchase history
  - name: Products
    description: Products configured in the Qonversion dashboard
  - name: Customers
    description: Aggregated customer records, properties, permissions, and metrics
  - name: Segments
    description: Dynamic and system segments of users
  - name: Experiments
    description: Paywall and offering A/B experiments
  - name: Screens
    description: No-code paywall screens — CRUD, publish, analytics
  - name: Analytics
    description: Charts, cards, cohorts, LTV, and insights
  - name: Exports
    description: Asynchronous data exports
  - name: Events
    description: Event catalog
  - name: Scheduled Reports
    description: Recurring reports delivered to external destinations
  - name: Integrations
    description: Third-party integrations configuration
  - name: Automations
    description: Event-driven automations
  - name: Project Settings
    description: Project-level configuration, secret, and store credentials
paths:
  /customers:
    get:
      tags:
        - Customers
      summary: List customers
      description: |
        Returns a paginated list of customers for the authenticated project.
        Manifest-compliant: list envelope, ISO 8601 timestamps.
      operationId: v4ListCustomers
      parameters:
        - name: page
          in: query
          description: Page number (1-based).
          required: false
          schema:
            type: integer
            minimum: 1
        - name: limit
          in: query
          description: Maximum number of customers to return.
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - name: sort_by
          in: query
          description: Field to sort results by.
          required: false
          schema:
            type: string
            x-extensible-enum:
              - created_at
              - revenue
              - total_revenue
        - name: sort_order
          in: query
          description: Sort direction.
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
        - name: environment
          in: query
          description: 'Filter by environment: `0` = sandbox, `1` = production.'
          required: false
          schema:
            type: integer
            enum:
              - 0
              - 1
        - name: search
          in: query
          description: Search query string.
          required: false
          schema:
            type: string
        - name: filter[status][]
          in: query
          description: >-
            Filter by customer status. Repeatable:
            filter[status][]=active&filter[status][]=churned.
          required: false
          schema:
            type: array
            items:
              type: string
        - name: filter[target_platform][]
          in: query
          description: Filter by target platform. Repeatable.
          required: false
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: A paginated list of customers.
          headers:
            x-request-id:
              description: Unique request identifier for tracing.
              schema:
                type: string
            Cache-Control:
              schema:
                type: string
                example: no-cache
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4CustomerList'
              example:
                object: list
                url: /v4/customers
                data:
                  - client_id: cl_01HXYZABCDEFGHJKMNPQRSTVWX
                    environment: 2
                    platform: iOS
                    status: active
                    country: US
                    since: '2026-03-18T09:42:11Z'
                    last_seen: '2026-04-22T18:05:33Z'
                    net_payments_usd: 59.97
                    payments_count: 3
                has_more: true
                next_cursor: cl_01HXYZABCDEFGHJKMNPQRSTVWX
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '403':
          description: Insufficient permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '502':
          description: Upstream service failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '504':
          description: Upstream timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
      security:
        - secretAuth: []
components:
  schemas:
    V4CustomerList:
      type: object
      required:
        - object
        - url
        - data
        - has_more
      properties:
        object:
          type: string
          enum:
            - list
        url:
          type: string
          example: /v4/customers
        data:
          type: array
          items:
            type: object
            description: Customer data (shape determined by the analytics service).
        has_more:
          type: boolean
        next_cursor:
          type: string
          description: Present only when has_more is true.
    V4Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
          properties:
            type:
              type: string
              enum:
                - request
                - resource
                - logical
                - internal
            code:
              type: string
              description: |
                Machine-readable snake_case error code. Examples include
                `invalid_data`, `invalid_request`, `invalid_product_id`,
                `not_found`, `already_exists`, `offering_already_exists`,
                `product_not_in_project`, `cannot_set_main_directly`,
                `cannot_demote_main`, `cannot_patch_experiment_variant`,
                `cannot_delete_experiment_variant`, and
                `cannot_setmain_experiment_variant`. Resource-specific codes
                are documented on the corresponding reference page.
            message:
              type: string
              description: Human-readable description. May change; do not parse.
            details:
              type: array
              nullable: true
              description: Per-field validation errors, present on 400 validation failures.
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
  securitySchemes:
    secretAuth:
      type: http
      scheme: bearer
      bearerFormat: sk_…
      description: >-
        Bearer authentication using the project **Secret Key** (prefixed with
        `sk_`, or `test_sk_` for sandbox). All v4 public endpoints require the
        Secret Key — see [Authentication](/reference/v4/authentication). Never
        expose the Secret Key in client-side code.

````