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

# Listar unidades

> Obtiene una lista paginada de unidades inmobiliarias publicadas.

Soporta filtros por tipo de operacion, proyecto, producto, tipo de producto,
estado, rango de precios, superficie, dormitorios, banos, barrio, ciudad,
y atributos EAV dinamicos.

Solo retorna unidades publicadas y no eliminadas.

### Filtros de primer nivel

Los filtros categoricos marcados como **multi** aceptan un solo valor o varios
separados por coma (`OR` entre valores). Ej: `possession_type=pozo,en_ejecucion`
o `status=disponible,reservado`.

| Parametro | Tipo | Descripcion |
|-----------|------|-------------|
| `listing_type` | string (multi) | Tipo de operacion: `venta`, `alquiler`, `alquiler_temporal`, `permuta` |
| `status` | string (multi) | Estado: `disponible`, `reservado`, `vendido`, etc. |
| `project_id` | uuid | UUID del proyecto |
| `product_id` | uuid | UUID del producto |
| `product_type` | string (multi) | Tipo de producto: `departamentos`, `casas`, `lotes`, etc. |
| `sku` | string | SKU exacto de la unidad |
| `stage` | string | Etapa (match exacto) |
| `sector` | string | Sector (busqueda parcial). Label variable segun product_type (Piso, Mza, SS2, etc.). |
| `unit` | string | Identificador de unidad (busqueda parcial). Label variable segun product_type (Depto, Lote, Cochera, etc.). |
| `min_price` / `max_price` | numeric | Rango de precio (inclusive) |
| `currency_type` | string (multi) | Moneda: `USD`, `ARS`, etc. |
| `min_total_area` / `max_total_area` | numeric | Rango de superficie total en m2 |
| `min_covered_area` / `max_covered_area` | numeric | Rango de superficie cubierta en m2 |
| `bedrooms` | integer (multi) | Cantidad exacta de dormitorios (match exacto, ej: `2,3`) |
| `min_bedrooms` | integer | Minimo de dormitorios |
| `bathrooms` | integer (multi) | Cantidad exacta de banos (match exacto, ej: `1,2`) |
| `min_bathrooms` | integer | Minimo de banos |
| `min_rooms` | integer | Minimo de ambientes |
| `possession_type` | string (multi) | Tipo de posesion: `pozo`, `inmediata`, `en_ejecucion` |
| `store_active` | boolean | Estado en tienda |

### Filtros de ubicacion

| Parametro | Tipo | Descripcion |
|-----------|------|-------------|
| `neighborhood` | string | Barrio (busqueda parcial) |
| `city` | string | Ciudad (busqueda parcial) |
| `state` | string | Provincia/estado (busqueda parcial) |

### Filtros por atributos EAV

Usar `filter[key]` para filtrar por cualquier atributo activo y filtrable.
Ejemplos: `filter[pool]=true`, `filter[orientation]=N`, `filter[parking_spaces][gte]=1`

### Flags frecuentes para store inmobiliario

| Checkbox UI | Parametro |
|-------------|-----------|
| Entrega inmediata | `possession_type=inmediata` |
| Oportunidad en contado | `filter[opportunity]=true` |
| Apto credito hipotecario | `filter[mortgage_eligible]=true` |

### Ordenamiento

| Parametro | Valores |
|-----------|---------|
| `sort_by` | `price`, `created_at`, `updated_at`, `sku`, `possession_date`, `total_area`, `covered_area`, `bedrooms`, `bathrooms`, `rooms` |
| `sort_direction` | `asc`, `desc` (default: `desc`) |

### Includes

Usar `include=attribute_categories` para incluir atributos EAV agrupados por categoria.
Usar `include=address` para incluir datos de ubicacion.
Combinar: `include=attribute_categories,address`



## OpenAPI

````yaml /api/openapi.json get /units
openapi: 3.1.0
info:
  title: Isprop API
  version: 1.0.0
  description: API para gestión de unidades inmobiliarias y leads de Isprop
servers:
  - url: https://{tenantDomain}/api/v1
    description: Dominio del tenant
    variables:
      tenantDomain:
        default: tenant.example.com
        description: Dominio asignado al tenant, sin protocolo ni ruta.
security:
  - http: []
tags:
  - name: Unit
  - name: Project
  - name: Product
  - name: Typology
  - name: Lead
  - name: Lead Channel
  - name: Attribute
paths:
  /units:
    get:
      tags:
        - Unit
      summary: Listar unidades
      description: >-
        Obtiene una lista paginada de unidades inmobiliarias publicadas.


        Soporta filtros por tipo de operacion, proyecto, producto, tipo de
        producto,

        estado, rango de precios, superficie, dormitorios, banos, barrio,
        ciudad,

        y atributos EAV dinamicos.


        Solo retorna unidades publicadas y no eliminadas.


        ### Filtros de primer nivel


        Los filtros categoricos marcados como **multi** aceptan un solo valor o
        varios

        separados por coma (`OR` entre valores). Ej:
        `possession_type=pozo,en_ejecucion`

        o `status=disponible,reservado`.


        | Parametro | Tipo | Descripcion |

        |-----------|------|-------------|

        | `listing_type` | string (multi) | Tipo de operacion: `venta`,
        `alquiler`, `alquiler_temporal`, `permuta` |

        | `status` | string (multi) | Estado: `disponible`, `reservado`,
        `vendido`, etc. |

        | `project_id` | uuid | UUID del proyecto |

        | `product_id` | uuid | UUID del producto |

        | `product_type` | string (multi) | Tipo de producto: `departamentos`,
        `casas`, `lotes`, etc. |

        | `sku` | string | SKU exacto de la unidad |

        | `stage` | string | Etapa (match exacto) |

        | `sector` | string | Sector (busqueda parcial). Label variable segun
        product_type (Piso, Mza, SS2, etc.). |

        | `unit` | string | Identificador de unidad (busqueda parcial). Label
        variable segun product_type (Depto, Lote, Cochera, etc.). |

        | `min_price` / `max_price` | numeric | Rango de precio (inclusive) |

        | `currency_type` | string (multi) | Moneda: `USD`, `ARS`, etc. |

        | `min_total_area` / `max_total_area` | numeric | Rango de superficie
        total en m2 |

        | `min_covered_area` / `max_covered_area` | numeric | Rango de
        superficie cubierta en m2 |

        | `bedrooms` | integer (multi) | Cantidad exacta de dormitorios (match
        exacto, ej: `2,3`) |

        | `min_bedrooms` | integer | Minimo de dormitorios |

        | `bathrooms` | integer (multi) | Cantidad exacta de banos (match
        exacto, ej: `1,2`) |

        | `min_bathrooms` | integer | Minimo de banos |

        | `min_rooms` | integer | Minimo de ambientes |

        | `possession_type` | string (multi) | Tipo de posesion: `pozo`,
        `inmediata`, `en_ejecucion` |

        | `store_active` | boolean | Estado en tienda |


        ### Filtros de ubicacion


        | Parametro | Tipo | Descripcion |

        |-----------|------|-------------|

        | `neighborhood` | string | Barrio (busqueda parcial) |

        | `city` | string | Ciudad (busqueda parcial) |

        | `state` | string | Provincia/estado (busqueda parcial) |


        ### Filtros por atributos EAV


        Usar `filter[key]` para filtrar por cualquier atributo activo y
        filtrable.

        Ejemplos: `filter[pool]=true`, `filter[orientation]=N`,
        `filter[parking_spaces][gte]=1`


        ### Flags frecuentes para store inmobiliario


        | Checkbox UI | Parametro |

        |-------------|-----------|

        | Entrega inmediata | `possession_type=inmediata` |

        | Oportunidad en contado | `filter[opportunity]=true` |

        | Apto credito hipotecario | `filter[mortgage_eligible]=true` |


        ### Ordenamiento


        | Parametro | Valores |

        |-----------|---------|

        | `sort_by` | `price`, `created_at`, `updated_at`, `sku`,
        `possession_date`, `total_area`, `covered_area`, `bedrooms`,
        `bathrooms`, `rooms` |

        | `sort_direction` | `asc`, `desc` (default: `desc`) |


        ### Includes


        Usar `include=attribute_categories` para incluir atributos EAV agrupados
        por categoria.

        Usar `include=address` para incluir datos de ubicacion.

        Combinar: `include=attribute_categories,address`
      operationId: listUnits
      responses:
        '200':
          description: Array of `UnitListResource`
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/UnitListItem'
                required:
                  - data
        '401':
          $ref: '#/components/responses/AuthenticationException'
        '422':
          $ref: '#/components/responses/ValidationException'
components:
  schemas:
    UnitListItem:
      type: object
      properties:
        id:
          type: string
        sku:
          type: string
        listing_type:
          type: string
        status:
          type: string
        name:
          type: string
        stage:
          type: string
        sector:
          type: string
        unit:
          type: string
        price:
          type: string
        formatted_price:
          type: string
        currency_type:
          type: string
        currency_label:
          type: string
        total_area:
          type: string
        covered_area:
          type: string
        bedrooms:
          type: string
        bathrooms:
          type: string
        rooms:
          type: string
        store_active:
          type: string
        possession_date:
          type: string
        possession_type:
          type: string
          enum:
            - pozo
            - inmediata
            - en_ejecucion
        financial:
          type: object
          description: Condiciones comerciales
          properties:
            integration_percentage:
              type: string
            integration_discount:
              type: string
            installments:
              type: string
            currency_index_type:
              type: string
          required:
            - integration_percentage
            - integration_discount
            - installments
            - currency_index_type
        published_at:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
        project:
          $ref: '#/components/schemas/ProjectSummary'
          description: Relaciones resumidas (2-3 campos clave por entidad)
        product:
          $ref: '#/components/schemas/ProductSummary'
        typology:
          anyOf:
            - $ref: '#/components/schemas/TypologySummary'
            - type: 'null'
        address:
          anyOf:
            - $ref: '#/components/schemas/AddressSummary'
            - type: 'null'
        media:
          type: object
          description: 'Galeria reducida: hasta 5 imagenes con URLs thumb + preview'
          properties:
            gallery:
              anyOf:
                - type: string
                - type: array
                  items:
                    type: string
                  minItems: 0
                  maxItems: 0
                  additionalItems: false
          required:
            - gallery
        attributes:
          type:
            - array
            - 'null'
          description: >-
            Atributos EAV como mapa plano { key: typed_value }. Emitido siempre
            que

            la relacion este cargada. Incluye campos denormalizados (bedrooms,

            total_area, etc) para que el mapa sea un snapshot completo de la
            unidad.
          items: {}
        badges:
          type: string
        attribute_categories: {}
      required:
        - id
        - sku
        - listing_type
        - status
        - name
        - stage
        - sector
        - unit
        - price
        - formatted_price
        - currency_type
        - currency_label
        - total_area
        - covered_area
        - bedrooms
        - bathrooms
        - rooms
        - store_active
        - possession_date
        - possession_type
        - financial
        - published_at
        - created_at
        - updated_at
        - media
        - attributes
        - badges
        - attribute_categories
      title: UnitListItem
    ProjectSummary:
      type: object
      properties:
        id:
          type: string
        slug:
          type: string
        name:
          type: string
        description:
          type: string
        tagline:
          type: string
        store_active:
          type: string
        logos:
          type:
            - array
            - 'null'
          items: {}
        address:
          anyOf:
            - $ref: '#/components/schemas/AddressSummary'
            - type: 'null'
        product_types:
          type:
            - array
            - 'null'
          description: >-
            Tipos de producto distintos entre los products del proyecto (ej:
            ["lotes"] o ["departamentos","cocheras","oficinas"])
          items: {}
        lots_map:
          type:
            - array
            - 'null'
          description: >-
            Config del overlay de tiles para la vista de mapa de lotes (null si
            el emprendimiento no tiene uno definido).
          items: {}
        has_lots_map:
          type: boolean
          description: >-
            Conveniencia para mostrar el toggle Lista/Mapa sin inspeccionar
            `lots_map`.
        published_at:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
      required:
        - id
        - slug
        - name
        - description
        - tagline
        - store_active
        - logos
        - product_types
        - lots_map
        - has_lots_map
        - published_at
        - created_at
        - updated_at
      title: ProjectSummary
    ProductSummary:
      type: object
      properties:
        id:
          type: string
        slug:
          type: string
        name:
          type: string
        description:
          type: string
        product_type:
          type: string
        product_type_label:
          type: string
        type_labels:
          type: object
          properties:
            sector:
              anyOf:
                - type: string
                - type: string
                  enum:
                    - Sector
            unit:
              anyOf:
                - type: string
                - type: string
                  enum:
                    - Unidad
          required:
            - sector
            - unit
        thumbnail_url:
          type:
            - string
            - 'null'
        store_active:
          type: string
        logos:
          type:
            - array
            - 'null'
          description: >-
            Override: null cuando el producto no tiene logo propio (el front cae
            al del project).
          items: {}
        project:
          $ref: '#/components/schemas/ProjectSummary'
        address:
          anyOf:
            - $ref: '#/components/schemas/AddressSummary'
            - type: 'null'
        published_at:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
      required:
        - id
        - slug
        - name
        - description
        - product_type
        - product_type_label
        - type_labels
        - thumbnail_url
        - store_active
        - logos
        - published_at
        - created_at
        - updated_at
      title: ProductSummary
    TypologySummary:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
      required:
        - id
        - name
      title: TypologySummary
    AddressSummary:
      type: object
      properties:
        country:
          type: string
        state:
          type: string
        city:
          type: string
        neighborhood:
          type: string
      required:
        - country
        - state
        - city
        - neighborhood
      title: AddressSummary
  responses:
    AuthenticationException:
      description: Unauthenticated
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
              - message
    ValidationException:
      description: Validation error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Errors overview.
              errors:
                type: object
                description: A detailed description of each field that failed validation.
                additionalProperties:
                  type: array
                  items:
                    type: string
            required:
              - message
              - errors
  securitySchemes:
    http:
      type: http
      scheme: bearer
      bearerFormat: sanctum

````

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