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

# Listar clientes

> Lista os clientes da sua organizacao.

Lista os clientes da organizacao autenticada. Paginacao por `page` e `limit` (maximo 100). Nao expoe documento, telefone nem dados de cartao.

Se `page` estiver além do fim, a API retorna `data: []` com `total`, `page`, `limit` e `total_pages` validos.

Exemplo de resposta:

```json theme={null}
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "external_customer_id": "customer-ext-0001",
      "name": "John Doe",
      "email": "john@example.com"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 10,
  "total_pages": 1
}
```

Erros comuns: `400` (query invalida), `401`/`403` (auth/produto), `429` (20 req/min).


## OpenAPI

````yaml GET /v1/customers
openapi: 3.0.0
info:
  title: UvviPay Public API
  description: >-
    Endpoints públicos da plataforma UvviPay para integração de subcontas
    (submerchants).
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.uvvipay.com.br
    description: Produção
  - url: https://api-staging.uvvipay.com.br
    description: Staging
security:
  - client-id: []
    client-secret: []
tags: []
paths:
  /v1/customers:
    get:
      tags:
        - Clientes
      summary: Listar clientes
      description: >-
        Lista os clientes da organização autenticada. Não expõe documento,
        telefone nem dados de cartão. Se `page` estiver além do fim, retorna
        `data: []` com `total`, `page`, `limit` e `total_pages` válidos.
      operationId: listRecurrencyCustomers
      parameters:
        - name: client-id
          in: header
          description: ID público da credencial do merchant
          required: true
          schema:
            type: string
        - name: client-secret
          in: header
          description: Secret da credencial do merchant
          required: true
          schema:
            type: string
        - name: page
          in: query
          required: false
          description: Página (1-based)
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: limit
          in: query
          required: false
          description: Itens por página (máximo 100)
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
      responses:
        '200':
          description: >-
            Página de clientes. Página além do fim: `data: []` com metadados
            válidos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRecurrencyCustomersResponseDto'
              examples:
                page:
                  summary: Página com itens
                  value:
                    data:
                      - id: 550e8400-e29b-41d4-a716-446655440001
                        external_customer_id: customer-ext-0001
                        name: John Doe
                        email: john@example.com
                    total: 1
                    page: 1
                    limit: 10
                    total_pages: 1
                empty_page:
                  summary: Página além do fim
                  value:
                    data: []
                    total: 5
                    page: 99
                    limit: 10
                    total_pages: 1
        '400':
          description: Parâmetros inválidos (`page` ou `limit` fora do intervalo)
        '401':
          description: Credenciais inválidas ou ausentes
        '403':
          description: Produto `recurrency` não habilitado para o merchant
        '429':
          description: Limite de requisições excedido (20 requests per 60 seconds)
components:
  schemas:
    ListRecurrencyCustomersResponseDto:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/RecurrencyCustomerDto'
        total:
          type: integer
        page:
          type: integer
        limit:
          type: integer
        total_pages:
          type: integer
      example:
        data:
          - id: 550e8400-e29b-41d4-a716-446655440001
            external_customer_id: customer-ext-0001
            name: John Doe
            email: john@example.com
        total: 1
        page: 1
        limit: 10
        total_pages: 1
    RecurrencyCustomerDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        external_customer_id:
          type: string
          nullable: true
        name:
          type: string
        email:
          type: string
          format: email
  securitySchemes:
    client-id:
      type: apiKey
      in: header
      name: client-id
    client-secret:
      type: apiKey
      in: header
      name: client-secret

````