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

> Retrieves promotion details for the provided array of UUIDs that are assigned to the facility, most recently updated first. Only returns promotions that have not been archived.



## OpenAPI

````yaml /openapi/integration-openapi.json post /api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/promotions/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}/promotions/get_by_uuids:
    post:
      tags:
        - Promotions
      summary: Get promotions by UUIDs
      description: >-
        Retrieves promotion details for the provided array of UUIDs that are
        assigned to the facility, most recently updated first. Only returns
        promotions that have not been archived.
      operationId: PrivateApiPromotionsController_getPromotionsByUuids
      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/GetPromotionsByUuidsRequestDto'
      responses:
        '200':
          description: Promotion details retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PromotionDetailsResponseDto'
        '400':
          description: Bad Request (e.g., Too many uuids, invalid input)
components:
  schemas:
    GetPromotionsByUuidsRequestDto:
      type: object
      properties:
        promotionUuids:
          example:
            - 3fa85f64-5717-4562-b3fc-2c963f66afa6
            - 3fa85f64-5717-4562-b3fc-2c963f66afa7
          description: Array of promotion UUIDs to retrieve data for
          type: array
          items:
            type: string
            format: uuid
      required:
        - promotionUuids
    PromotionDetailsResponseDto:
      type: object
      properties:
        promotionUuid:
          type: string
          format: uuid
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          description: UUID of the promotion
        tenantType:
          type: string
          enum:
            - Business
            - Personal
            - All
          example: Personal
          description: Tenant type for the promotion
        promotionCategory:
          type: string
          enum:
            - MANUALLY_APPLIED
            - AUTOMATICALLY_APPLIED
          example: MANUALLY_APPLIED
          description: >-
            MANUALLY_APPLIED → added manually by user via Monument FMS,
            AUTOMATICALLY_APPLIED → added automatically during check-out if unit
            meets conditions
        isAutoPayRequired:
          type: boolean
          example: false
          description: Whether auto pay is required for this promotion
        promotionName:
          type: string
          example: Summer Special
          description: Name of the promotion
        description:
          type: string
          nullable: true
          example: Special summer discount
          description: Description of the promotion
        note:
          type: string
          nullable: true
          example: Valid until end of summer
          description: Note about the promotion
        discountType:
          type: string
          nullable: true
          enum:
            - FIXED_AMOUNT
            - PERCENTAGE
          example: PERCENTAGE
          description: >-
            FIXED_AMOUNT → fixed amount, referenced in fixedDiscountAmount
            field, PERCENTAGE → percentage of rent, referenced in
            discountPercentage field
        discountAmountType:
          type: string
          example: OFF_RENT
          description: Discount amount type
        fixedDiscountAmount:
          type: number
          nullable: true
          example: 1000
          description: Fixed discount amount in pennies (e.g., $10.50 = 1050)
        discountPercentage:
          type: number
          nullable: true
          example: 10.5
          description: Discount percentage (e.g., 10.5 for 10.5%)
        durationInMonths:
          type: number
          nullable: true
          example: 3
          description: >-
            Number of monthly invoices to apply promotion to. When 0, it applies
            to all invoices.
        monthStarts:
          type: number
          nullable: true
          example: 0
          description: >-
            The billing month the promotion will start. 0 = applies to the
            move-in invoice, 1 = applies to the first monthly generated invoice
            after move-in
        createdAt:
          type: string
          format: date-time
          example: '2024-01-15T10:30:00.000Z'
          description: Timestamp when the promotion was created
        updatedAt:
          type: string
          format: date-time
          example: '2024-01-20T15:45:00.000Z'
          description: Timestamp when the promotion was last updated
        unitGroupUuids:
          example:
            - 3fa85f64-5717-4562-b3fc-2c963f66afa6
            - 3fa85f64-5717-4562-b3fc-2c963f66afa7
          description: List of unit group UUIDs the promotion is assigned to
          type: array
          items:
            type: string
            format: uuid
        isActive:
          type: boolean
          example: false
          description: Whether promotion is active
      required:
        - promotionUuid
        - tenantType
        - promotionCategory
        - isAutoPayRequired
        - promotionName
        - description
        - note
        - discountType
        - discountAmountType
        - fixedDiscountAmount
        - discountPercentage
        - durationInMonths
        - monthStarts
        - createdAt
        - updatedAt
        - unitGroupUuids
        - isActive

````