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

# GET Lease

> Returns a lease with its abstracted terms.



## OpenAPI

````yaml /api-reference/v1/openapi.json get /rest/v1/leases/{leaseId}
openapi: 3.1.0
info:
  title: Prophia API v1 (deprecated)
  version: v1
  description: >-
    The original read-only Prophia REST API. It is deprecated: new integrations
    should use v2.
servers:
  - url: https://api.prophia.com
    description: Prophia API
security:
  - apiKey: []
tags:
  - name: Accounts
    description: The account your API key belongs to, and leases that changed recently.
  - name: Properties
    description: A single property and its buildings.
  - name: Buildings
    description: A single building and its leases.
  - name: Leases
    description: A single lease with its abstracted terms.
paths:
  /rest/v1/leases/{leaseId}:
    get:
      tags:
        - Leases
      summary: GET Lease
      description: Returns a lease with its abstracted terms.
      operationId: getLeaseV1
      parameters:
        - name: leaseId
          in: path
          required: true
          schema:
            type: string
          description: >-
            Accepts the Prophia ID or your own custom ID. A custom ID is looked
            up in the account your API key belongs to.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Lease'
        '403':
          description: >-
            The API key is missing, unknown or revoked, can't see this resource,
            or no resource matches the ID.
      deprecated: true
components:
  schemas:
    Lease:
      type: object
      properties:
        accountId:
          type: string
        propertyId:
          type: string
        propertyCustomId:
          type: string
        propertyName:
          type: string
        buildingId:
          type: string
        buildingCustomId:
          type: string
        buildingName:
          type: string
        buildingType:
          type: string
          enum:
            - OFFICE
            - INDUSTRIAL
            - RETAIL
            - MIXED_USE
            - OTHER
            - LIFE_SCIENCES
            - MEDICAL_OFFICE
            - FLEX
        address:
          $ref: '#/components/schemas/Address'
        id:
          type: string
        tenantLegalName:
          type: string
        dba:
          type: string
        customId:
          type: string
        url:
          type: string
        leaseStatus:
          type: string
        leaseType:
          type: string
          enum:
            - OFFICE
            - GSA_OFFICE
            - RETAIL
            - INDUSTRIAL
            - STORAGE
            - LICENSE_AGREEMENT
            - TELECOM_ANTENNA
            - PARKING_AGREEMENT
            - ROOFTOP_SOLAR
        leasedFloors:
          type: string
        suiteNumber:
          type: string
        squareFootage:
          type: integer
          format: int32
        currentTerm:
          type: object
          additionalProperties:
            type: string
        commencementDate:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/CommencementDate'
        originalCommencementDate:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/CommencementDate'
        expirationDate:
          type: object
          additionalProperties:
            type: string
            format: date-time
        remainingTerm:
          type: integer
          format: int32
        termType:
          type: string
        goDark:
          type: string
        estoppel:
          type: string
        rent:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Rent'
        futureRent:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Rent'
        percentageRent:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PercentRent'
        deferredRentAmount:
          type: object
          additionalProperties:
            type: string
        deferredRentPeriod:
          type: object
          additionalProperties:
            type: string
        prepaidRentAmount:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Prepaid'
        prepaidRentPeriod:
          type: object
          additionalProperties:
            type: string
        guarantor:
          type: string
        lateFee:
          type: string
        letterOfCreditAmount:
          type: object
          additionalProperties:
            type: string
        letterOfCreditRefundSchedule:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Reduction'
        letterOfCreditInstitution:
          type: string
        rentBumpIndex:
          type: object
          additionalProperties:
            type: string
        securityDepositAmount:
          type: object
          additionalProperties:
            type: string
        securityDepositRefundSchedule:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Reduction'
        tiRentInterestRate:
          type: object
          additionalProperties:
            type: string
        bsacRentInterestRate:
          type: object
          additionalProperties:
            type: string
        rentReviewDate:
          type: object
          additionalProperties:
            type: string
        baseYear:
          type: object
          additionalProperties:
            type: string
        baseTaxYear:
          type: object
          additionalProperties:
            type: string
        baseOpexYear:
          type: object
          additionalProperties:
            type: string
        baseYearStop:
          type: object
          additionalProperties:
            type: string
        baseTaxYearStop:
          type: object
          additionalProperties:
            type: string
        baseOpexYearStop:
          type: object
          additionalProperties:
            type: string
        expenseAccounts:
          type: string
        opexTaxType:
          type: object
          additionalProperties:
            type: string
        holdover:
          type: string
        prs:
          type: object
          additionalProperties:
            type: string
        taxPrs:
          type: object
          additionalProperties:
            type: string
        opexPrs:
          type: object
          additionalProperties:
            type: string
        taxAccounts:
          type: string
        grossUp:
          type: string
        monthlySalesStatement:
          type: string
        quarterlySalesStatement:
          type: string
        annualSalesStatement:
          type: string
        conferenceRoomUsage:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        exclusiveUse:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        fitnessUsage:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        signage:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        storageUsage:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        telecomAntenna:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        purchaseOffer:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        petAllowance:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        naming:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        sublet:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        llKickout:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        salesKickout:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        salesKickoutTenant:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        llRelocation:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        loungeUsage:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        operatingCotenancy:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        openingCotenancy:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        permittedUse:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        prohibitedUse:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        parking:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        rightOfFirstOffer:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        rightOfFirstRefusal:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        expansion:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        renewal:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        earlyTermination:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        contractionRight:
          type: array
          items:
            $ref: '#/components/schemas/Option'
        tenantImprovement:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/TenantImprovement'
        rentAbatement:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Abatement'
        opexAbatement:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Abatement'
        taxAbatement:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Abatement'
        otherConcession:
          type: array
          items:
            $ref: '#/components/schemas/Concession'
        fee:
          type: array
          items:
            $ref: '#/components/schemas/Fee'
        customTags:
          type: object
          additionalProperties:
            type: string
    Address:
      type: object
      properties:
        address1:
          type: string
        address2:
          type: string
        city:
          type: string
        state:
          type: string
        country:
          type: string
        zipcode:
          type: string
    CommencementDate:
      type: object
      properties:
        tagName:
          type: string
        commencementDate:
          type: string
          format: date-time
    Rent:
      type: object
      properties:
        fixedRETaxes:
          type: number
        fixedOpex:
          type: number
        fixedParking:
          type: number
        cpiIncreaseAmount:
          type: number
        totalMonthlyRent:
          type: number
        totalAnnualRent:
          type: number
        tiRentInterestRate:
          type: string
        bsacRentInterestRate:
          type: string
        annualBaseRent:
          type: number
        annualBaseRentPSF:
          type: number
        monthlyBaseRent:
          type: number
        annualTiRent:
          type: number
        annualBsacRent:
          type: number
        futureRentIncreases:
          type: array
          items:
            $ref: '#/components/schemas/RentIncreaseAtTime'
        startDate:
          type: string
          format: date-time
        endDate:
          type: string
          format: date-time
        squareFootage:
          type: integer
          format: int32
    PercentRent:
      type: object
      properties:
        percentRentSchedule:
          type: array
          items:
            $ref: '#/components/schemas/PercentRentPeriod'
        percentRentValueInText:
          type: string
    Prepaid:
      type: object
      properties:
        amountText:
          type: string
        includeOpex:
          type: boolean
        amount:
          type: number
    Reduction:
      type: object
      properties:
        applies:
          type: string
        futureRefundList:
          type: array
          items:
            $ref: '#/components/schemas/Refund'
    Option:
      type: object
      properties:
        encumberedSpaces:
          type: string
        rightAvailable:
          type: boolean
        rightNotAvailableReason:
          type: string
        rentalRate:
          type: string
        effectivePeriod:
          $ref: '#/components/schemas/Period'
        rightStatus:
          type: string
        clause:
          type: string
        optionName:
          type: string
        advanceNoticePeriod:
          $ref: '#/components/schemas/Period'
        applicableSpace:
          type: string
        rightExpirationDate:
          type: string
        encumberedFloors:
          type: string
        earlyExpirationDate:
          type: string
        earlyExpirationFee:
          type: string
        renewalTerm:
          type: string
        numberOfAdditionalTerm:
          type: integer
          format: int32
        encumbranceFrequency:
          type: string
        effectiveDate:
          type: string
          format: date-time
        optionExpired:
          type: boolean
        identifier:
          type: string
    TenantImprovement:
      type: object
      properties:
        tiSunset:
          $ref: '#/components/schemas/Date'
        currentOffer:
          $ref: '#/components/schemas/Number'
        tiRemaining:
          type: string
    Abatement:
      type: object
      properties:
        abatementSchedule:
          type: array
          items:
            $ref: '#/components/schemas/AbatementPeriod'
        abatementInText:
          type: string
    Concession:
      type: object
      properties:
        concessionName:
          type: string
        spaces:
          type: string
        amount:
          type: number
    Fee:
      type: object
      properties:
        feeSchedule:
          type: array
          items:
            $ref: '#/components/schemas/FeeTerm'
        amountText:
          type: string
        feeName:
          type: string
        spaces:
          type: string
    RentIncreaseAtTime:
      type: object
      properties:
        totalAnnualRent:
          type: number
        annualBaseRent:
          type: number
        annualBaseRentPSF:
          type: number
        monthlyBaseRent:
          type: number
        annualBsacRent:
          type: number
        annualTiiRent:
          type: number
        startDate:
          type: string
          format: date-time
        endDate:
          type: string
          format: date-time
        squareFootage:
          type: integer
          format: int32
    PercentRentPeriod:
      type: object
      properties:
        fullLeaseTerm:
          type: boolean
        basedOnMinimumRent:
          type: boolean
        breakpointAmount:
          type: number
        percentRentAmount:
          type: number
        startDate:
          type: string
          format: date-time
        endDate:
          type: string
          format: date-time
        startMonth:
          type: integer
          format: int32
        endMonth:
          type: integer
          format: int32
    Refund:
      type: object
      properties:
        reductionAmount:
          type: number
        reductionDate:
          type: string
          format: date-time
        amount:
          type: number
    Period:
      type: object
      properties:
        startDate:
          type: string
          format: date-time
        endDate:
          type: string
          format: date-time
    Date:
      type: object
      properties:
        valueInText:
          type: string
        valueCapturedInDoc:
          type: string
        value:
          type: string
          format: date-time
    Number:
      type: object
      properties:
        value:
          type: number
        unit:
          type: string
    AbatementPeriod:
      type: object
      properties:
        includesTaxAndOpex:
          type: boolean
        unit:
          type: string
        startDate:
          type: string
          format: date-time
        endDate:
          type: string
          format: date-time
        amount:
          type: number
        termUnit:
          type: string
        startTerm:
          type: number
        endTerm:
          type: number
    FeeTerm:
      type: object
      properties:
        annual:
          type: number
        percentIncrease:
          type: number
        monthly:
          type: number
        monthlyPsf:
          type: number
        oneTime:
          type: boolean
        startDate:
          type: string
          format: date-time
        endDate:
          type: string
          format: date-time
  securitySchemes:
    apiKey:
      type: apiKey
      description: >-
        Prophia API key — either an account key (grants admin level permissions)
        or a user key with the REST scope. Send it in the `X-API-Key` header, or
        equivalently as `Authorization: Bearer <api-key>`. JWTs are rejected on
        /rest endpoints with 401.
      name: X-API-Key
      in: header

````

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