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

# Obtener clientes paginados con filtros

> Entrega una lista paginada de clientes con filtros de busqueda, ciudad, orden y condiciones de negocio como clientes con suscripcion, empresas matriz o exclusion de hijos.



## OpenAPI

````yaml /generated/specs/clients.json get /api/v1/client/all/paginated
openapi: 3.0.0
info:
  title: Raul API - Clientes
  description: Clientes, clientes padre, direcciones, contactos y activos asociados.
  version: 2.0.0
  contact: {}
servers:
  - url: https://api.raul.ugps.io
    description: Production
security: []
tags:
  - name: Clients
    description: Gestion de clientes
paths:
  /api/v1/client/all/paginated:
    get:
      tags:
        - Clients
      summary: Obtener clientes paginados con filtros
      description: >-
        Entrega una lista paginada de clientes con filtros de busqueda, ciudad,
        orden y condiciones de negocio como clientes con suscripcion, empresas
        matriz o exclusion de hijos.
      operationId: ClientListController_getAllPaginated
      parameters:
        - name: min_subscriptions
          required: false
          in: query
          description: Mínimo de suscripciones activas, inclusivo
          schema:
            type: number
            minimum: 0
        - name: max_subscriptions
          required: false
          in: query
          description: Máximo de suscripciones activas, inclusivo
          schema:
            type: number
            minimum: 0
        - name: page
          required: false
          in: query
          schema:
            minimum: 1
            default: 1
            allOf:
              - $ref: '#/components/schemas/Object'
        - name: limit
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 5000
            default: 50
            allOf:
              - $ref: '#/components/schemas/Object'
        - name: search
          required: false
          in: query
          description: Buscar por nombre, fantasía o RUT
          schema:
            maxLength: 200
            type: string
        - name: city_id
          required: false
          in: query
          description: UUID de la ciudad
          schema:
            type: string
        - name: sort
          required: false
          in: query
          schema:
            default: gps_count
            type: string
            enum:
              - client_name
              - rut
              - gps_count
              - gpsCount
              - created_at
              - updated_at
        - name: order
          required: false
          in: query
          schema:
            default: desc
            type: string
            enum:
              - asc
              - desc
        - name: has_subscription
          required: false
          in: query
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
        - name: is_parent
          required: false
          in: query
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
        - name: exclude_children
          required: false
          in: query
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
      responses:
        '200':
          description: Lista paginada de clientes
      security:
        - bearerAuth: []
components:
  schemas:
    Object:
      type: object
      properties: {}
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Token de sesión Better Auth para rutas de backoffice; las rutas de
        portal usan su token propio.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.