> ## 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 lead details by UUIDs

> Returns details for specified leads associated with a facility, including primary person information and lead source.



## OpenAPI

````yaml /openapi/integration-openapi.json post /api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/leads/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}/leads/get_by_uuids:
    post:
      tags:
        - Leads
      summary: Get lead details by UUIDs
      description: >-
        Returns details for specified leads associated with a facility,
        including primary person information and lead source.
      operationId: PrivateApiLeadsController_getLeadsByUuids
      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/GetLeadsByUuidsRequestDto'
      responses:
        '200':
          description: Lead details retrieved
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LeadDetailsResponseDto'
        '400':
          description: Bad Request (e.g., Too many uuids, invalid input)
components:
  schemas:
    GetLeadsByUuidsRequestDto:
      type: object
      properties:
        leadUuids:
          example:
            - 3fa85f64-5717-4562-b3fc-2c963f66afa6
            - 3fa85f64-5717-4562-b3fc-2c963f66afa7
          description: Array of lead UUIDs to retrieve details for
          type: array
          items:
            type: string
            format: uuid
      required:
        - leadUuids
    LeadDetailsResponseDto:
      type: object
      properties:
        leadUuid:
          type: string
          format: uuid
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          description: Lead UUID
        unitGroupUuid:
          type: string
          nullable: true
          format: uuid
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          description: Unit group UUID (if selected)
        leadStatus:
          type: string
          enum:
            - OPEN
            - CONVERTED
            - LOST
            - PENDING
            - RESERVED
            - WAITLISTED
          example: OPEN
          description: Lead status
        accountStatus:
          type: string
          nullable: true
          enum:
            - PENDING_ACTIVATION
            - ACTIVE
            - PENDING_DEACTIVATION
            - DEACTIVATED
          example: ACTIVE
          description: Account status
        businessName:
          type: string
          nullable: true
          example: ABC Company
          description: Business name (if applicable)
        accountUuid:
          type: string
          nullable: true
          format: uuid
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          description: Account UUID (if applicable)
        primaryPerson:
          nullable: true
          description: Primary person information
          allOf:
            - $ref: '#/components/schemas/PrimaryPersonDto'
        leadSource:
          type: string
          nullable: true
          example: Website
          description: Lead source description
        dateDesiredMoveIn:
          type: string
          nullable: true
          example: '2024-01-15'
          description: Desired move-in date
        dateCreated:
          format: date-time
          type: string
          example: '2024-01-01T00:00:00.000Z'
          description: Date when the lead was created
        dateUpdated:
          format: date-time
          type: string
          example: '2024-01-01T00:00:00.000Z'
          description: Date when the lead was last updated
      required:
        - leadUuid
        - unitGroupUuid
        - leadStatus
        - accountStatus
        - dateCreated
        - dateUpdated
    PrimaryPersonDto:
      type: object
      properties:
        firstName:
          type: string
          nullable: true
          example: John
          description: First name of the primary person
        lastName:
          type: string
          nullable: true
          example: Doe
          description: Last name of the primary person
        phone:
          type: string
          nullable: true
          example: '1234567890'
          description: Phone of the primary person
        email:
          type: string
          nullable: true
          example: test@email.com
          description: Email of the primary person
        addressLine1:
          type: string
          nullable: true
          example: 123 Main St
          description: Address line 1 of the primary person
        addressLine2:
          type: string
          nullable: true
          example: Apt 4B
          description: Address line 2 of the primary person
        city:
          type: string
          nullable: true
          example: New York
          description: City of the primary person
        state:
          type: string
          nullable: true
          example: NY
          description: State of the primary person
        zip:
          type: string
          nullable: true
          example: '10001'
          description: ZIP code of the primary person

````