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

# Get units by UUIDs

> Retrieves unit details for the provided array of UUIDs within a specific facility, most recently updated first



## OpenAPI

````yaml /openapi/integration-openapi.json post /api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/units/get_by_uuids
openapi: 3.0.0
info:
  title: Monument Integration API
  description: Monument Integration API
  version: '1.0'
  contact: {}
servers:
  - url: https://public-api.prd.monument.io
    description: Production
  - url: https://public-api.stg.monument.io
    description: Staging
security: []
tags:
  - name: Portfolios
    description: List portfolios accessible to the API key
  - name: Facilities
    description: Facility retrieval and coverage-option configuration
  - name: Units
    description: Unit listing and MORA execution
  - name: Unit Groups
    description: Unit group listing, rate management, and unit assignment
  - name: Rental Records
    description: Rental record listing, coverage, fees, autopay, and payment links
  - name: Ledger Entries
    description: Ledger entry retrieval at facility and rental-record level
  - name: Leads
    description: Lead listing and lease sending
  - name: Tasks
    description: Task creation and listing for integrations
  - name: Tenants
    description: Tenant listing and person updates
  - name: People
    description: Person listing
  - name: Notes
    description: Note listing and creation for tenants and leads
  - name: Auctions
    description: Auction listing
  - name: Coverage
    description: Portfolio-level coverage CRUD and coverage history
  - name: Summary
    description: Portfolio-level aggregate summaries (insurance enrollment/occupancy)
  - name: Promotions
    description: Promotion listing
  - name: ECRI
    description: Effective Current Rent Increase scheduling
  - name: Item Types
    description: Item type listing per facility
  - name: Delinquencies
    description: Delinquency listing per facility
  - name: Physical Locks
    description: Physical lock assignment and unassignment
  - name: Lead Source Options
    description: Lead source option listing
  - name: Webhooks
    description: Webhook subscription management
  - name: Payments
    description: Payment profile creation
paths:
  /api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/units/get_by_uuids:
    post:
      tags:
        - Units
      summary: Get units by UUIDs
      description: >-
        Retrieves unit details for the provided array of UUIDs within a specific
        facility, most recently updated first
      operationId: PrivateApiUnitsController_getUnitsByUuids
      parameters:
        - name: facilityUuid
          required: true
          in: path
          schema:
            type: string
        - in: path
          required: true
          name: portfolio
          schema:
            example: abc_selfstorage
        - in: header
          required: true
          name: x-api-key
          schema:
            example: monument-2230012-2312321
            description: >-
              Api key required to authenticate your request. Please reach out to
              monument for a key.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetUnitsByUuidsRequestDto'
      responses:
        '200':
          description: Unit details retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UnitDetailsResponseDto'
        '400':
          description: Bad Request (e.g., Too many uuids, invalid input)
components:
  schemas:
    GetUnitsByUuidsRequestDto:
      type: object
      properties:
        unitUuids:
          example:
            - 3fa85f64-5717-4562-b3fc-2c963f66afa6
            - 3fa85f64-5717-4562-b3fc-2c963f66afa7
          description: Array of unit UUIDs to retrieve details for
          type: array
          items:
            type: string
            format: uuid
      required:
        - unitUuids
    UnitDetailsResponseDto:
      type: object
      properties:
        unitUuid:
          type: string
          format: uuid
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          description: Unit UUID
        facilityUuid:
          type: string
          format: uuid
          example: 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d
          description: Facility UUID where the unit is located
        unitNumber:
          type: string
          example: A101
          description: Unit number identifier
        floor:
          type: string
          example: Floor 1
          description: Floor specification
        type:
          type: string
          example: Climate-Controlled
          nullable: true
          description: Unit type description
        tier:
          type: string
          example: Premium
          nullable: true
          description: Unit tier description
        amenities:
          example:
            - Climate-Controlled
            - Digital Lock
          nullable: true
          description: Unit amenities
          type: array
          items:
            type: string
        contents:
          nullable: true
          example:
            - Table, Chair, etc.
          description: Unit contents
          type: array
          items:
            type: string
        status:
          type: string
          enum:
            - VACANT
            - RESERVED
            - OCCUPIED
            - UNRENTABLE
            - OWNER OCCUPIED
            - PENDING_SIGNATURE
          example: VACANT
          description: Unit occupancy status
        currentTenantUuid:
          type: string
          nullable: true
          format: uuid
          example: 5a6b7c8d-9e0f-1a2b-3c4d-5e6f7a8b9c0d
          description: Account UUID of the current tenant (active rental record)
        currentRentalRecordUuid:
          type: string
          nullable: true
          format: uuid
          example: 6b7c8d9e-0f1a-2b3c-4d5e-6f7a8b9c0d1e
          description: Unit rental record UUID of the active rental
        unitGroupUuid:
          type: string
          nullable: true
          format: uuid
          example: 7c8d9e0f-1a2b-3c4d-5e6f-7a8b9c0d1e2f
          description: Unit group UUID this unit belongs to
        currentStreetRate:
          type: number
          nullable: true
          example: 15000
          description: Unit current street rate in pennies
        currentWebRate:
          type: number
          nullable: true
          example: 10000
          description: Unit current web rate  in pennies
        width:
          type: number
          example: 10.5
          description: Unit width
        height:
          type: number
          example: 8
          description: Unit height
        depth:
          type: number
          example: 10
          description: Unit depth
        monthlyRentAmount:
          type: number
          example: 12500
          description: Monthly rent amount in pennies
        createdAt:
          type: string
          format: date-time
          example: '2024-01-15T10:30:00.000Z'
          description: Timestamp when the unit was created
        updatedAt:
          type: string
          format: date-time
          example: '2024-01-20T15:45:00.000Z'
          description: Timestamp when the unit was last updated
      required:
        - unitUuid
        - facilityUuid
        - unitNumber
        - floor
        - contents
        - status
        - currentTenantUuid
        - currentRentalRecordUuid
        - unitGroupUuid
        - currentStreetRate
        - currentWebRate
        - width
        - height
        - depth
        - monthlyRentAmount
        - createdAt
        - updatedAt

````