> ## 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 tenants by UUIDs

> Retrieves tenant details for the provided array of accountUuids, most recently updated first.



## OpenAPI

````yaml /openapi/integration-openapi.json post /api/{portfolio}/portfolios/v1/tenants/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/tenants/get_by_uuids:
    post:
      tags:
        - Tenants
      summary: Get tenants by UUIDs
      description: >-
        Retrieves tenant details for the provided array of accountUuids, most
        recently updated first.
      operationId: PrivateApiTenantsController_getTenantsByUuids
      parameters:
        - 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/GetTenantsByUuidsRequestDto'
      responses:
        '200':
          description: Tenant details retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TenantDetailsResponseDto'
        '400':
          description: Bad Request (e.g., Too many uuids, invalid input)
components:
  schemas:
    GetTenantsByUuidsRequestDto:
      type: object
      properties:
        tenantUuids:
          example:
            - a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11
            - a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a12
          description: Array of tenant UUIDs to retrieve details for
          type: array
          items:
            type: string
            format: uuid
      required:
        - tenantUuids
    TenantDetailsResponseDto:
      type: object
      properties:
        tenantUuid:
          type: string
          format: uuid
          example: a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11
          description: Tenant UUID
        rentalRecordUuids:
          example:
            - 3fa85f64-5717-4562-b3fc-2c963f66afa6
            - 3fa85f64-5717-4562-b3fc-2c963f66afa7
          description: Array of associated rental record UUIDs
          type: array
          items:
            type: string
            format: uuid
        accountType:
          $ref: '#/components/schemas/AccountType'
          example: Personal
        businessName:
          type: string
          nullable: true
          example: Acme Storage LLC
          description: Business name (populated for BUSINESS accounts, null for PERSONAL)
        noteUuids:
          example:
            - 4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e
            - 5c6d7e8f-9a0b-1c2d-3e4f-5a6b7c8d9e0f
          description: Array of note UUIDs associated with the tenant
          type: array
          items:
            type: string
            format: uuid
        createdAt:
          type: string
          format: date-time
          example: '2024-01-15T10:30:00.000Z'
          description: Timestamp when the tenant was created
        updatedAt:
          type: string
          format: date-time
          example: '2024-01-20T15:45:00.000Z'
          description: Timestamp when the tenant was last updated
        primaryPersonUuid:
          type: string
          format: uuid
          example: a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11
          description: Primary person UUID associated with the tenant
        primaryContact:
          description: Primary contact details for the tenant
          allOf:
            - $ref: '#/components/schemas/PrimaryContactDto'
        alternateContacts:
          example: []
          description: Array of alternate contact details (if available)
          type: array
          items:
            $ref: '#/components/schemas/ContactDto'
        nextBillingDueDate:
          type: string
          nullable: true
          format: date-time
          example: '2024-02-15T00:00:00.000Z'
          description: Earliest billing due date from billing templates for this tenant
        owedBalance:
          type: number
          nullable: true
          example: 1250.5
          description: >-
            Sum of the positive balances for the unit rental records associated
            with this tenant, this does not include credits when tenant does not
            owe money. Returned in pennies.
        balanceAge:
          type: number
          nullable: true
          example: 15
          description: >-
            Days since today for the oldest created date of still
            open/overdue/partial invoices. 0 if no such invoices exist
        active:
          type: boolean
          example: true
          description: >-
            Whether the tenant has any active rental records (startRentDate <=
            now and (endRentDate >= now or endRentDate is null))
        sourceLeadUuids:
          example:
            - 6fa85f64-5717-4562-b3fc-2c963f66afa6
            - 7fa85f64-5717-4562-b3fc-2c963f66afa7
          description: Array of lead UUIDs associated with this account
          type: array
          items:
            type: string
            format: uuid
        desiredMoveInDate:
          type: string
          nullable: true
          format: date-time
          example: '2024-03-15T00:00:00.000Z'
          description: Desired move-in date from associated leads
      required:
        - tenantUuid
        - rentalRecordUuids
        - accountType
        - noteUuids
        - createdAt
        - updatedAt
        - primaryPersonUuid
        - primaryContact
        - active
        - sourceLeadUuids
    AccountType:
      type: string
      description: Account type
      enum:
        - Business
        - Personal
    PrimaryContactDto:
      type: object
      properties:
        firstName:
          type: string
          example: Jane
          description: Contact's first name
        lastName:
          type: string
          example: Doe
          description: Contact's last name
        address1:
          type: string
          nullable: true
          example: 123 Main St
          description: Contact's address line 1
        address2:
          type: string
          nullable: true
          example: Apt 4B
          description: Contact's address line 2
        city:
          type: string
          nullable: true
          example: Anytown
          description: Contact's city
        state:
          type: string
          nullable: true
          maxLength: 2
          example: CA
          description: Contact's state
        zipcode:
          type: string
          nullable: true
          maxLength: 10
          example: '90210'
          description: Contact's zip code
        email:
          type: string
          nullable: true
          example: jane.doe@example.com
          description: Contact's email address
        phone:
          type: string
          nullable: true
          example: '+15551234567'
          description: Contact's phone number
        optedIntoSms:
          type: boolean
          example: true
          description: Whether the contact has opted into SMS
        driverLicenseNumber:
          type: string
          nullable: true
          example: '1234567890'
          description: Driver license number
        driverLicenseState:
          type: string
          nullable: true
          example: CA
          description: Driver license state
        passportNumber:
          type: string
          nullable: true
          example: '1234567890'
          description: Passport number
        passportCountry:
          type: string
          nullable: true
          example: US
          description: Passport country
        documentExpirationDate:
          type: string
          nullable: true
          example: '2024-01-01'
          description: Document expiration date
        dateOfBirth:
          type: string
          nullable: true
          example: '2024-01-01'
          description: Date of birth
      required:
        - firstName
        - lastName
        - optedIntoSms
    ContactDto:
      type: object
      properties:
        firstName:
          type: string
          nullable: true
          example: Jane
          description: Contact's first name
        lastName:
          type: string
          nullable: true
          example: Doe
          description: Contact's last name
        address1:
          type: string
          nullable: true
          example: 123 Main St
          description: Contact's address line 1
        address2:
          type: string
          nullable: true
          example: Apt 4B
          description: Contact's address line 2
        city:
          type: string
          nullable: true
          example: Anytown
          description: Contact's city
        state:
          type: string
          nullable: true
          maxLength: 2
          example: CA
          description: Contact's state
        zipcode:
          type: string
          nullable: true
          maxLength: 10
          example: '90210'
          description: Contact's zip code
        email:
          type: string
          nullable: true
          example: jane.doe@example.com
          description: Contact's email address
        phone:
          type: string
          nullable: true
          example: '+15551234567'
          description: Contact's phone number
        optedIntoSms:
          type: boolean
          nullable: true
          example: true
          description: Whether the contact has opted into SMS
        dateOfBirth:
          type: string
          nullable: true
          example: '2024-01-01'
          description: Date of birth

````