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

> ## Agent Instructions
> OwnPay is licensed under AGPL-3.0 and is completely free - no licensing fees.
> Production docs URL: https://ownpay.org/docs - append .md to any page URL for clean markdown.
> OwnPay requires PHP 8.3+, MySQL/MariaDB, and Redis.
> MCP server available at https://ownpay.org/docs/mcp for programmatic documentation queries.
> Use root-relative links (e.g. /quickstart) for internal navigation - do NOT include /docs prefix.
> Plugin development: consult /developer/plugin-types/ pages for correct interfaces and manifests.

# List Customers

> Retrieves a paginated list of customer records for the active brand.
PII values (name, email, phone) are securely processed. Masked helper fields are provided for general display lists.




## OpenAPI

````yaml /api/merchant_api.yaml get /customers
openapi: 3.1.0
info:
  title: OwnPay Merchant API
  description: >
    The OwnPay Merchant API enables merchants to programmatically interface with
    their white-labeled payment gateway.

    It exposes endpoints to initiate payments (creating payment intents), query
    transaction statuses, issue full or partial refunds, manage customer
    profiles securely in compliance with GDPR and OWASP, generate and revoke API
    keys, and test/audit webhook delivery attempts.


    ### Authentication

    Authentication is performed via HTTP Bearer token in the `Authorization`
    header.

    ```http

    Authorization: Bearer your_api_key_here

    ```

    API keys carry specific privilege scopes (e.g., `read`, `write`, `admin`).

    Some administrative operations (like listing/generating API keys) require
    **both** `write` and `admin` scopes, as well as passing a valid platform
    super-administrator's email address in the `X-Super-Admin-Email` header for
    safety.
  version: 1.0.0
servers:
  - url: https://{brand_domain}/api/v1
    description: Sandbox or Production white-labeled brand gateway API server.
    variables:
      brand_domain:
        default: ownpay.org
        description: The custom domain configured for your white-labeled brand.
security:
  - BearerAuth: []
paths:
  /customers:
    get:
      summary: List Customers
      description: >
        Retrieves a paginated list of customer records for the active brand.

        PII values (name, email, phone) are securely processed. Masked helper
        fields are provided for general display lists.
      operationId: listCustomers
      parameters:
        - name: page
          in: query
          description: Page number to retrieve.
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: per_page
          in: query
          description: Records per page.
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
      responses:
        '200':
          description: Paginated customers list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCustomersResponse'
components:
  schemas:
    PaginatedCustomersResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
                example: 58
              uuid:
                type: string
                format: uuid
                example: 83b9c9d2-b2f4-4df1-bc1e-b810d1c810d1
              name:
                type: string
                example: Alice Smith
              email:
                type: string
                nullable: true
                example: alice@example.com
              phone:
                type: string
                nullable: true
                example: '+8801800000000'
              email_masked:
                type: string
                nullable: true
                example: a***e@example.com
              phone_masked:
                type: string
                nullable: true
                example: +88018******00
              created_at:
                type: string
                format: date-time
                example: '2026-06-23T14:15:45Z'
        meta:
          type: object
          properties:
            page:
              type: integer
              example: 1
            per_page:
              type: integer
              example: 25
            total:
              type: integer
              example: 98
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Provide the Bearer API Key generated for your brand.

````

## Related topics

- [OwnPay API Overview - REST API for Multi-Brand Payments](/docs/api/overview.md)
- [Features and Capabilities](/docs/resources/features.md)
- [Laravel SDK - Fluent Payment Integration for PHP Apps](/docs/developer/integration/laravel.md)
- [Merchant API Reference - Payments, Refunds, and Webhooks](/docs/api-reference/merchant.md)
- [Customers - Profiles, Transaction History, and Methods](/docs/user-guide/people/customers.md)