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).

GET

/api/v2/onlineleasing-link/

Request

Example requestGET

$ curl -X GET \
    -H "Authorization: Bearer YOUR_API_KEY" \
    "https://api.funnelleasing.com/api/v2/onlineleasing-link/"

Response

Example responseJSON200 · application/json

302 Found
Location: https://onlineleasing.funnelleasing.com/apply/...

📝

Parameter Requirements: You must provide either communityID OR myOlePropertyId (not both). When using myOlePropertyId, you must also provide companyID.

Examples

The following examples demonstrate different ways to use the Online Leasing Link API, from minimal requests to full-featured integrations.

Minimal Examples

Using communityID (Preferred)

This example shows the minimal required parameters using the recommended method for identifying properties. The communityID is a Funnel-assigned identifier that provides the most reliable way to reference a property.

Minimal request with communityIDHTTP

GET /api/v2/onlineleasing-link/?communityID=78349

Using myOlePropertyId (Alternative)

This example shows the minimal required parameters using your internal property ID from your PMS system. This method requires proper integration mapping between your system and Funnel.

Minimal request with myOlePropertyIdHTTP

GET /api/v2/onlineleasing-link/?myOlePropertyId=myComm34&companyID=456

Full Examples (All Parameters)

Using communityID

This example includes all optional parameters to pre-fill the leasing application with property, unit, lease term, and move-in date information. All optional parameters are included to provide the most complete pre-filled experience.

Full request with all parameters (communityID)HTTP

GET /api/v2/onlineleasing-link/?communityID=78349&sLeaseTerm=12&MoveInDate=12/30/2022&UnitID=789

Using myOlePropertyId

This example includes all optional parameters using your internal property ID instead of communityID. This demonstrates how to use the alternative property identifier method with all available optional parameters.

Full request with all parameters (myOlePropertyId)HTTP

GET /api/v2/onlineleasing-link/?myOlePropertyId=123&companyID=456&sLeaseTerm=12&MoveInDate=12/30/2022&UnitID=789

Partial Optional Parameters

You can include any combination of optional parameters. This example shows a request with lease term and move-in date, but without a specific unit. This flexibility allows you to pre-fill only the information that's relevant to your use case.

Request with some optional parametersHTTP

GET /api/v2/onlineleasing-link/?communityID=78349&sLeaseTerm=24&MoveInDate=06/15/2024

Error Responses

The API may return the following error responses when invalid parameters are provided or when requested resources cannot be found.

Invalid Parameter Combination (400)

When both myOlePropertyId and communityID are provided, a 400 error response will be returned.

Error responseJSON400 · application/json

{
  "error_type": "Invalid",
  "message": "Invalid parameter combination: when both myOlePropertyId and communityID are provided"
}

Invalid Lease Term Format (400)

When sLeaseTerm is not a valid integer, a 400 error response will be returned.

Error responseJSON400 · application/json

{
  "error_type": "Invalid",
  "message": "Invalid lease term format: when sLeaseTerm is not a valid integer"
}

Missing Parameter (400)

When neither myOlePropertyId nor communityID is provided, a 400 error response will be returned.

Error responseJSON400 · application/json

{
  "error_type": "Invalid",
  "message": "Missing parameter: when neither myOlePropertyId nor communityID is provided"
}

Incorrect Move In Date Format (400)

When MoveInDate doesn't match MM/DD/YYYY format, a 400 error response will be returned.

Error responseJSON400 · application/json

{
  "error_type": "Invalid",
  "message": "Incorrect move in date format: when MoveInDate doesn't match MM/DD/YYYY format"
}

Invalid Integration Identifier (404)

When myOlePropertyId doesn't match any integration, a 404 error response will be returned.

Error responseJSON404 · application/json

{
  "error_type": "DoesNotExist",
  "message": "Invalid integration identifier: when myOlePropertyId doesn't match any integration"
}

Community Does Not Exist (404)

When communityID is invalid, a 404 error response will be returned.

Error responseJSON404 · application/json

{
  "error_type": "DoesNotExist",
  "message": "Community does not exist: when communityID is invalid"
}

Unit Does Not Exist (404)

When UnitID doesn't match any unit, a 404 error response will be returned.

Error responseJSON404 · application/json

{
  "error_type": "DoesNotExist",
  "message": "Unit does not exist: when UnitID doesn't match any unit"
}

Lease Settings Do Not Exist (404)

When the community has no active lease settings, a 404 error response will be returned.

Error responseJSON404 · application/json

{
  "error_type": "DoesNotExist",
  "message": "Lease settings do not exist: when the community has no active lease settings"
}