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

# Listar clientes

> Lista paginada de clientes del negocio, ordenada por fecha de creación (descendente). Usa `cursor` con el `nextCursor` de la respuesta anterior.



## OpenAPI

````yaml /openapi.json get /api/clients
openapi: 3.1.0
info:
  title: FinUp API
  version: 1.0.0
  description: >-
    API para que sistemas externos (ERP, CRM, scripts) operen sobre un negocio
    de FinUp: clientes, créditos, cuotas, pagos, sucursales, configuraciones,
    reportes y auditoría.


    Autenticación con **API key** del negocio (ver
    [Authentication](/api/authentication)), enviada como `Authorization: Bearer
    <clave>` o como header `X-API-Key: <clave>`. El alcance de la clave es
    **solo lectura** (`read`: únicamente métodos seguros `GET`/`HEAD`/`OPTIONS`)
    o **acceso total** (`full`: lectura y escritura).


    Quedan fuera de este contrato los endpoints de sesión web (p. ej. `GET
    /api/me` y `/api/admin/*`) y los públicos (p. ej. `POST /api/leads`); no se
    invocan con una API key.
servers:
  - url: https://api.finup.ar
    description: Producción
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Clientes
    description: Alta, edición y consulta de clientes.
  - name: Créditos
    description: Créditos y sus cuotas.
  - name: Pagos
    description: Registro de pagos y movimientos (ledger).
  - name: Configuraciones
    description: Planes de crédito.
  - name: Sucursales
    description: Sucursales del negocio.
  - name: Usuarios
    description: Usuarios internos (empleados y administradores).
  - name: Reportes
    description: Exportaciones y resumen.
  - name: Auditoría
    description: Registro de cambios.
  - name: Verificación
    description: Consulta ARCA (ex AFIP) y BCRA.
  - name: Archivos
    description: Documentación adjunta de clientes.
  - name: API keys
    description: Administración de claves de la API.
paths:
  /api/clients:
    get:
      tags:
        - Clientes
      summary: Listar clientes
      description: >-
        Lista paginada de clientes del negocio, ordenada por fecha de creación
        (descendente). Usa `cursor` con el `nextCursor` de la respuesta
        anterior.
      operationId: listClients
      parameters:
        - name: search
          in: query
          required: false
          description: Busca por nombre, apellido o DNI.
          schema:
            type: string
        - name: branch_id
          in: query
          required: false
          description: Filtra clientes con créditos en la sucursal.
          schema:
            type: string
            format: uuid
        - name: limit
          in: query
          required: false
          description: Tamaño de página (máx. 100, por defecto 50).
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
        - name: cursor
          in: query
          required: false
          description: Cursor opaco devuelto como `nextCursor`.
          schema:
            type: string
      responses:
        '200':
          description: Página de clientes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientPage'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    ClientPage:
      type: object
      properties:
        clients:
          type: array
          items:
            $ref: '#/components/schemas/Client'
        nextCursor:
          type:
            - string
            - 'null'
          description: Pasalo como `?cursor=` para la próxima página; `null` si no hay más.
    Client:
      type: object
      properties:
        id:
          type: string
          format: uuid
        business_id:
          type: string
          format: uuid
        first_name:
          type:
            - string
            - 'null'
        last_name:
          type:
            - string
            - 'null'
        dni:
          type: string
        sex:
          anyOf:
            - type: string
              enum:
                - m
                - f
                - o
            - type: 'null'
        street:
          type:
            - string
            - 'null'
        street_number:
          type:
            - string
            - 'null'
        floor:
          type:
            - string
            - 'null'
        apartment:
          type:
            - string
            - 'null'
        city:
          type:
            - string
            - 'null'
        state:
          type:
            - string
            - 'null'
        country:
          type:
            - string
            - 'null'
        zip_code:
          type:
            - string
            - 'null'
        phone:
          type:
            - string
            - 'null'
        alt_phone:
          type:
            - string
            - 'null'
        email:
          type:
            - string
            - 'null'
          format: email
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: string
      required:
        - error
  responses:
    BadRequest:
      description: Datos inválidos.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: API key ausente o inválida.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key del negocio enviada como `Authorization: Bearer <clave>`. El
        alcance `read` solo permite métodos seguros (`GET`/`HEAD`/`OPTIONS`);
        `full` permite además escribir.
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Alternativa a `Authorization: Bearer`: la misma API key del negocio en
        el header `X-API-Key`. Aplica la misma regla de alcance por método
        (`read` = solo `GET`/`HEAD`/`OPTIONS`).

````