Skip to content
Funnel Leasing

Apply Link

The Online Leasing Link API provides a way to redirect users to a Funnel online leasing application with pre-filled data based on provided parameters. This endpoint allows for seamless integration of the online leasing process into your website or application.

The endpoint redirects to a Funnel online leasing application where the data will be pre-filled based on the provided parameters (property, unit, move in date, and lease term).

Base URL
GET /api/v2/onlineleasing-link/

Required Parameters

  • Name
    companyID
    Type
    integer
    Description
    Your Funnel company id. This is a Funnel assigned id for your company.
  • Name
    Property Identifier
    Type
    Description
    You must provide exactly one of the following to identify the property. Providing both or neither will result in an error. It is recommended to use `communityID` as it is the preferred method.
      • Name
        communityID
        Type
        integer
        Description
        The Funnel community ID. This is a Funnel assigned id for your community.This is the recommended way to identify a property in Funnel.
      • Name
        myOlePropertyId
        Type
        string
        Description
        This is the ID of the property/community in your PMS (not the same as Funnel's community ID).
Minimal Example (Required Parameters Only)
# Preferred: using communityID
GET /api/v2/onlineleasing-link/?communityID=78349&companyID=456


# Alternative: using myOlePropertyId
GET /api/v2/onlineleasing-link/?myOlePropertyId=myComm34&companyID=456

Optional Parameters

  • Name
    sLeaseTerm
    Type
    integer
    Description
    Lease term duration in months. Must be a valid integer.
  • Name
    MoveInDate
    Type
    string
    Description
    The move in date in format MM/DD/YYYY (example: 12/30/2022). Must strictly follow this format.
  • Name
    UnitID
    Type
    integer/string
    Description
    Can be either your internal unit id or the unit number. The API will attempt to match the unit using either value.
Full Example (All Parameters)
GET /api/v2/onlineleasing-link/?myOlePropertyId=123&companyID=456&sLeaseTerm=12&MoveInDate=12/30/2022&UnitID=789

Error Responses

The API may return the following error responses:

Status CodeError TypeDescription
400InvalidInvalid parameter combination: when both myOlePropertyId and communityID are provided
400InvalidInvalid lease term format: when sLeaseTerm is not a valid integer
400InvalidMissing parameter: when neither myOlePropertyId nor communityID is provided
400InvalidIncorrect move in date format: when MoveInDate doesn’t match MM/DD/YYYY format
404DoesNotExistInvalid integration identifier: when myOlePropertyId doesn’t match any integration
404DoesNotExistCommunity does not exist: when communityID is invalid
404DoesNotExistUnit does not exist: when UnitID doesn’t match any unit
404DoesNotExistLease settings do not exist: when the community has no active lease settings