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

# List customers

> Returns a paginated list of customers.



## OpenAPI

````yaml /api-reference/openapi.json get /api/gateway/customers
openapi: 3.1.0
info:
  title: Open Rails API
  version: 0.1.0
  description: >-
    Hosted checkout, provider routing, runtime schemas, and normalized webhook
    examples for Open Rails merchants and agents.
servers:
  - url: https://dash.getopenrails.com
    description: Production dashboard and API origin
security: []
tags:
  - name: Gateway
  - name: Agent
  - name: Routing
  - name: Webhooks
paths:
  /api/gateway/customers:
    get:
      tags:
        - Gateway
      summary: List customers
      description: Returns a paginated list of customers.
      operationId: listGatewayCustomers
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            default: 20
        - name: customerId
          in: query
          schema:
            type: string
        - name: email
          in: query
          schema:
            type: string
            format: email
        - name: status
          in: query
          schema:
            type: string
      responses:
        '200':
          description: List of customers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerListResponse'
components:
  schemas:
    CustomerListResponse:
      type: object
      required:
        - object
        - data
        - hasMore
      properties:
        object:
          type: string
          enum:
            - list
        data:
          type: array
          items:
            $ref: '#/components/schemas/Customer'
        hasMore:
          type: boolean
    Customer:
      type: object
      required:
        - id
        - object
        - email
        - status
        - created
      properties:
        id:
          type: string
          description: Customer ID with cus_* prefix.
        object:
          type: string
          enum:
            - customer
        email:
          type: string
          format: email
        status:
          type: string
        created:
          type: string
          format: date-time

````