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

# Listar Clientes

> Retorna uma lista paginada de clientes.

**Permissão requerida:** `CUSTOMER:READ` ou `FULL_ACCESS`



## OpenAPI

````yaml GET /customers
openapi: 3.0.0
info:
  title: pague.dev API
  description: pague.dev Payment API documentation
  version: '1.0'
  contact: {}
servers:
  - url: https://api.pague.dev/v1
security: []
paths:
  /customers:
    get:
      tags:
        - External API - Customers
      summary: Listar clientes
      description: |-
        Retorna uma lista paginada de clientes.

        **Permissão requerida:** `CUSTOMER:READ` ou `FULL_ACCESS`
      operationId: ExternalCustomersController_getAllCustomers
      parameters:
        - name: X-API-Key
          in: header
          description: >-
            Chave de API de integração (pd_live_* para produção, pd_test_* para
            sandbox)
          required: true
          schema:
            type: string
        - name: page
          required: false
          in: query
          description: Número da página
          schema:
            minimum: 1
            default: 1
            type: integer
        - name: limit
          required: false
          in: query
          description: Itens por página
          schema:
            minimum: 1
            maximum: 100
            default: 20
            type: integer
        - name: search
          required: false
          in: query
          description: Buscar por nome, e-mail ou documento
          schema:
            example: joao
            type: string
      responses:
        '200':
          description: Lista de clientes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllCustomersOutput'
        '401':
          description: Unauthorized - Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
components:
  schemas:
    GetAllCustomersOutput:
      type: object
      properties:
        items:
          description: Lista de clientes
          type: array
          items:
            $ref: '#/components/schemas/CreateCustomerOutput'
        total:
          type: integer
          description: Número total de clientes
          example: 100
        page:
          type: integer
          description: Página atual
          example: 1
        limit:
          type: integer
          description: Itens por página
          example: 20
        totalPages:
          type: integer
          description: Número total de páginas
          example: 5
      required:
        - items
        - total
        - page
        - limit
        - totalPages
    UnauthorizedErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
          example: 401
        error:
          type: string
          example: Unauthorized
        message:
          type: string
          example: Authentication token is required
        details:
          type: object
        timestamp:
          type: string
          example: '2025-12-15T22:00:00.000Z'
        traceId:
          type: string
      required:
        - statusCode
        - error
        - message
        - timestamp
    InternalServerErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
          example: 500
        error:
          type: string
          example: InternalError
        message:
          type: string
          example: An unexpected error occurred
        details:
          type: object
        timestamp:
          type: string
          example: '2025-12-15T22:00:00.000Z'
        traceId:
          type: string
          example: 2771463d58840c8e116dc6dda1e1e5d0
      required:
        - statusCode
        - error
        - message
        - timestamp
    CreateCustomerOutput:
      type: object
      properties:
        id:
          type: string
          description: ID do cliente
          format: uuid
        name:
          type: string
          description: Nome do cliente
          example: João da Silva
        email:
          type: string
          description: E-mail do cliente
          format: email
        phone:
          type: string
          description: Telefone do cliente com DDI
          example: '+5511999998888'
        documentType:
          type: string
          description: Tipo do documento
          enum:
            - cpf
            - cnpj
        document:
          type: string
          description: Número do documento mascarado
          example: '***456789**'
        createdAt:
          type: string
          description: Data de criação
          format: date-time
      required:
        - id
        - name
        - email
        - documentType
        - document
        - createdAt

````