Skip to content

RentEngine Public API (1.1.1)

Integrate your systems anywhere with RentEngine.

Authorization

This API uses JWT Bearer token authentication. Follow these steps to obtain and use your API tokens:

Obtaining API Tokens

  1. Log in to your RentEngine developer portal
  2. In the top corner, click the "Create New API Key" button
  3. Provide a name for your token (e.g., "Integration Name")
  4. Click Create
  5. Copy the token to your clipboard and save it securely as it will not be displayed again

Important Security Notice: Your token will only be displayed ONCE at creation time. Make sure to copy it and store it securely. For security reasons, we cannot display the token again after this point.

Using API Tokens

Include your token in all API requests as a Bearer token in the Authorization header:

Authorization: Bearer your_token_here

Token Security Best Practices

  • Store tokens securely in environment variables or a secure vault
  • Never hardcode tokens in your application code
  • Do not share tokens in public repositories or client-side code
  • Use separate tokens for different integrations or environments

Token Permissions

Each token generated by a user will have the full permissions of the user that created it across all accounts associated with that user. Actions will be logged in the name of that user & token.

Invalidating Tokens

Tokens will not expire. (Well not for 100 years at least). If a token is compromised or no longer needed:

  1. Log in to your RentEngine developer portal
  2. Find the token you wish to invalidate in the table in the API Keys section
  3. Click the "Revoke Token" icon that looks like a trash can

Once revoked, a token cannot be restored. You'll need to create a new token if needed.

Pagination

All list endpoints in the RentEngine API support pagination to efficiently handle large datasets. Here's how to use pagination in your API requests:

Pagination Parameters

When making requests to list endpoints (e.g., /lockboxes, /lockbox_events, /units), you can include the following query parameters:

  • limit - Controls how many items to return per page (default: 50, max: 100)
  • page_number - Specifies which page to retrieve (0-indexed, default: 0)

Example request with pagination:

GET /api/public/v1/lockboxes?limit=25&page_number=1

This would return the second page of results with 25 items per page.

Response Format

Paginated responses include only the requested data. The total number of items across all pages is not included in the response.

Iterating Through Pages

To retrieve all items across multiple pages, increment the page_number parameter until you've processed all pages. You can determine when you've reached the end when the response is shorter than the limit requested.

Performance Considerations

  • Use appropriate limit values based on your needs. Smaller values reduce payload size but require more API calls, which can slow down performance and be subject to rate limits.
  • When filtering data, apply filters in the query parameters first to reduce the total number of items that need to be fetched.

Webhooks

RentEngine provides webhooks to notify your systems about events in real-time. This allows you to build integrations that respond immediately to changes in your RentEngine data.

Setting Up Webhooks

Webhooks can be configured through the RentEngine developer portal. You'll need to specify:

  1. The target URL where webhook events should be sent
  2. The data you want to monitor (e.g., lockboxes, units, lockbox_events)
  3. The event types you want to receive (INSERT, UPDATE, DELETE)
  4. An optional API key that will be included in webhook requests to your endpoint

Webhook Payload Structure

Webhook payloads follow this general structure:

{
  "type": "INSERT|UPDATE|DELETE",
  "table": "table_name",
  "record": { /* The current state of the record (null for DELETE) */ },
  "old_record": { /* The previous state of the record (null for INSERT) */ }
}

The specific fields in record and old_record will depend on the table that triggered the event.

Event Types

  • INSERT: Sent when a new record is created
  • UPDATE: Sent when an existing record is modified
  • DELETE: Sent when a record is deleted

Security Considerations

  • Webhook endpoints should be HTTPS to ensure secure transmission of data
  • Validate the API key included in the webhook request to ensure it's coming from RentEngine
  • Implement idempotency in your webhook handlers to prevent duplicate processing

Webhook Delivery

RentEngine uses a reliable delivery system (QStash) to ensure webhooks are delivered even during temporary outages. If your endpoint is unavailable, we'll retry delivery with exponential backoff.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://rentengine.io

E-mail

eng@rentengine.io

Languages
Servers
Mock server

https://rentengine.redocly.app/_mock/openapi/

Production environment

https://app.rentengine.io/api/public/v1/

Staging environment

https://staging-app.rentengine.io/api/public/v1/

Lockboxes

Operations for managing lockboxes

Operations

Lockbox Events

Operations for tracking and creating lockbox events

OperationsWebhooks

Lockbox Installations

Operations for retrieving lockbox installations

Operations

Units

Operations for managing rental units

OperationsWebhooks

Get units

Request

Retrieve units with optional filtering and pagination

Security
BearerAuth
Query
unitIdsArray of numbers

Filter by comma-separated list of unit IDs

Example: unitIds=12345,67890
extracted_fromstring

Any string that can be used to identify the unit in an external system. Essentially the same as an external_id, but not limited to an ID format. Uniqueness is not enforced.

Example: extracted_from=f78125c
accountIdstring

Filter by account ID

Example: accountId=4b88ff32-8ba0-4bbf-8e60-c789909ac176
statusesArray of strings

Filter by comma-separated list of unit statuses

Items Enum"Incomplete""Under Review""Available""Archived""Leased""On Hold""Expired""Withdrawn""Withdrawal Requested""Price Analysis"
Example: statuses=Available,Incomplete
limitinteger[ 1 .. 100 ]

Maximum number of items to return per page (default 50, max 100)

Default 50
Example: limit=25
page_numberinteger>= 0

Page number for pagination (0-indexed, default 0)

Default 0
Example: page_number=1
curl -i -X GET \
  'https://rentengine.redocly.app/_mock/openapi/units?unitIds=12345%2C67890&extracted_from=f78125c&accountId=4b88ff32-8ba0-4bbf-8e60-c789909ac176&statuses=Available%2CIncomplete&limit=25&page_number=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success. Returns a list of units.

Bodyapplication/jsonArray [
idintegerrequired

Unique identifier for the unit

Example: 3318
created_atstring(date-time)required

Timestamp when the unit was created

Example: "2024-10-05T18:53:03.406168Z"
updated_atstring(date-time)required

Timestamp when the unit was last updated

Example: "2024-10-05T18:53:03.406168Z"
addressintegerrequired

ID of the address record associated with this unit

Example: 957
property_typestring

Type of property

Enum"SINGLE FAMILY RESIDENCE""DUPLEX""TRIPLEX""MULTI-FAMILY""CONDO""TOWNHOUSE""ROOM""ADU"
Example: "TOWNHOUSE"
bedroomsstring

Number of bedrooms

Example: "3"
bathroomsstring

Number of bathrooms

Example: "2"
sqftstring

Square footage of the unit

Example: "1378"
furnishedboolean

Whether the unit is furnished

Example: false
renovatedstring

Whether the unit has been renovated

Example: "No"
num_parking_spotsstring

Number of parking spots

Example: "2"
laundrystring

Laundry options

Enum"In Unit""Shared""Coin-op""Hookups but no machines""Machines In Unit - Tenant Responsible""None"
Example: "In Unit"
target_rental_ratestring

Target rental rate for the unit in dollars per month. 1925 means $1925/month

Example: "1925"
is_occupiedboolean

Whether the unit is currently occupied

Example: false
earliest_move_in_datestring(date)

Earliest date the unit is available for move-in

Example: "2024-10-12"
allow_cooperating_brokersboolean or null

Whether cooperating brokers are allowed

Example: true
desired_lease_duration_monthsArray of integers

Desired lease duration in months

Example: [12]
pets_allowedstring or null

Pet policy

Enum"Yes""Yes with pet fee""Dogs only""Dogs only with pet fee""Cats only""Cats only with pet fee""No"
Example: "Yes with pet fee"
pet_restrictionsstring

Restrictions on pets

Example: "A MINIMUM NON-REFUNDABLE pet fee in the amount of $300 per pet is required"
hoa_app_requiredboolean or null

Whether HOA application is required

Example: true
hoa_app_feenumber or null

HOA application fee in dollars

Example: 100
hoa_application_urlstring or null

URL for HOA application

Example: "https://example.com/application"
key_accessstring

Key access information

Enum"Digital Lockbox Connected to RentEngine""Single code lockbox with key""Digital door lock with code""I will add this later""Accompanied Showing"
Example: "I will add this later"
access_instructionsstring

Instructions for accessing the unit

Example: "Lockbox/Door Code: Tenant Turner"
min_resident_qualificationsstring

Minimum qualifications for residents

Example: ""
utilities_includedArray of strings

Utilities included in rent

Items Enum"Water""Sewer/Septic""Trash""Wifi/Internet""Cable/TV""Electricity""Gas""HOA""Lawn Care""Pool Service"
Example: ["Lawn Care","Trash"]
parking_typeArray of strings

Type of parking available

Items Enum"Street""Carport""Assigned Spots""Driveway""Shared Garage""Private Garage""Paid Parking"
Example: ["Assigned Spots"]
storm_protectionstring

Storm protection features

Example: "None"
statusstring

Current status of the unit

Example: "Leased"
send_showing_notificationsboolean

Whether to send showing notifications

Example: true
send_leasing_update_emailboolean

Whether to send leasing update emails

Example: true
extracted_fromstring

Source of the unit data. Can be a any string. Essentially the same as an external_id. Uniqueness is not enforced.

Example: "f123abc"
marketing_descriptionstring

Marketing description of the unit

Example: "**AVAILABLE NOW** 3 Bedroom 2 Bathroom Townhome For Rent in Meadow Woods!"
marketing_photosArray of objects

Photos of the unit

commission_amountstring

Commission amount

Example: "1"
commission_typestring

Type of commission

Enum"percent""fixed""none""contact_mls_agent"
Example: "none"
imported_bystring or null

Who/what imported the unit

Example: "Rentvine Sync"
floor_numberinteger

Floor number of the unit. Best to use the floor of the entrance door if the unit spans multiple floors.

Example: 1
has_elevatorboolean or null

Whether the building has an elevator

Example: false
hoa_detailsobject

Details about the HOA

account_idstring(uuid)

ID of the account that owns the unit. Must be a valid account for which the api key has access.

Example: "269bf205-d876-42f5-988d-6f40891df58a"
owner_emailsArray of strings

Email addresses of the owners

Example: ["rick@amgrents.com"]
accepts_vouchersboolean or null

Whether the unit accepts housing vouchers.

Example: true
internal_notesstring or null

Internal notes about the unit.

Example: "Garage work scheduled for Monday."
amenitiesArray of strings

All amenities of the unit

Example: ["Dishwasher","Stove","Range Oven","Refrigerator"]
monthly_feesArray of objects or null

Monthly recurring fees

move_in_feesArray of objects or null

Fees required at move-in

multifamily_property_idstring or null(uuid)

ID of the multifamily property

Example: "421e4567-e89b-12d3-a456-426614174000"
showing_methodstring or nullrequired

Method for showing the unit

Enum"Accompanied""Remote Guided""Remote Guided with Gated Access""Self Guided"
Example: "Remote Guided"
floorplans_idstring or null(uuid)

ID of the floorplan

Example: "451e4567-e89b-12d3-a456-426614174000"
video_urlstring or null(url)

URL of video tour (such as YouTube, Vimeo, Zillow Tour, Matterport, Ricoh360, or zInspector tour)

Example: "https://www.youtube.com/watch?v=1234567890"
subteam_idstring or null(uuid)

ID of the subteam managing the unit

Example: "123e4567-e89b-12d3-a456-426614174000"
prescreen_template_idstring or null(uuid)

ID of the prescreening template to use for this unit, if it is null the default template will be used.

Example: "123e4567-e89b-12d3-a456-426614174000"
structured_access_instructionsSelf Guided/Remote Showing Instructions (object) or Accompanied Showing Instructions (object)

Structured access instructions that vary based on showing_method:

  • For "Self Guided" showing method: Use the self-guided showing instructions object
  • For "Remote Guided" or "Remote Guided with Gated Access" showing methods: Use the self-guided showing instructions object
  • For "Accompanied" showing method: Use either the legacy accompanied or accompanied showing instructions object

When updating structured_access_instructions, the showing_method field must also be set.

One of:

Structured access instructions that vary based on showing_method:

  • For "Self Guided" showing method: Use the self-guided showing instructions object
  • For "Remote Guided" or "Remote Guided with Gated Access" showing methods: Use the self-guided showing instructions object
  • For "Accompanied" showing method: Use either the legacy accompanied or accompanied showing instructions object

When updating structured_access_instructions, the showing_method field must also be set.

enable_send_reportbooleanrequired

Whether to enable sending reports

Example: true
earliest_showing_datestring(date)

Earliest date the unit can be shown

Example: "2024-10-12"
security_deposit_amountnumber or null

Amount of security deposit in dollars. 1000 means $1000.21

Example: 1000.21
require_last_month_rentboolean or null

Whether last month's rent is required upfront

Example: true
requires_voucherboolean or null

Whether a voucher is required

Example: false
custom_application_urlstring

URL for custom application

Example: "https://app.findigs.com/apply/unitid=70f51c4c-d708-402e-9a5f-bb6fd60b6cf2"
include_feedback_leasing_reportboolean

Whether to include feedback in leasing reports

Example: true
year_builtnumber or null>= 1800

Year the property was built

Example: 2020
application_feenumber or null>= 0

Application fee amount in dollars

Example: 50
]
Response
application/json
[
  {
    "id": 3318,
    "created_at": "2024-10-05T18:53:03.406168Z",
    "updated_at": "2024-10-05T18:53:03.406168Z",
    "address": 957,
    "property_type": "TOWNHOUSE",
    "bedrooms": "3",
    "bathrooms": "2",
    "sqft": "1378",
    "furnished": false,
    "renovated": "No",
    "num_parking_spots": "2",
    "laundry": "In Unit",
    "target_rental_rate": "1925",
    "is_occupied": false,
    "earliest_move_in_date": "2024-10-12",
    "allow_cooperating_brokers": true,
    "desired_lease_duration_months": [ … ],
    "pets_allowed": "Yes with pet fee",
    "pet_restrictions": "A MINIMUM NON-REFUNDABLE pet fee in the amount of $300 per pet is required",
    "hoa_app_required": true,
    "hoa_app_fee": 100,
    "hoa_application_url": "https://example.com/application",
    "key_access": "I will add this later",
    "access_instructions": "Lockbox/Door Code: Tenant Turner",
    "min_resident_qualifications": "",
    "utilities_included": [ … ],
    "parking_type": [ … ],
    "storm_protection": "None",
    "status": "Leased",
    "send_showing_notifications": true,
    "send_leasing_update_email": true,
    "extracted_from": "f123abc",
    "marketing_description": "**AVAILABLE NOW** 3 Bedroom 2 Bathroom Townhome For Rent in Meadow Woods!",
    "marketing_photos": [ … ],
    "commission_amount": "1",
    "commission_type": "none",
    "imported_by": "Rentvine Sync",
    "floor_number": 1,
    "has_elevator": false,
    "hoa_details": { … },
    "account_id": "269bf205-d876-42f5-988d-6f40891df58a",
    "owner_emails": [ … ],
    "accepts_vouchers": true,
    "internal_notes": "Garage work scheduled for Monday.",
    "amenities": [ … ],
    "monthly_fees": [ … ],
    "move_in_fees": [ … ],
    "multifamily_property_id": "421e4567-e89b-12d3-a456-426614174000",
    "showing_method": "Remote Guided",
    "floorplans_id": "451e4567-e89b-12d3-a456-426614174000",
    "video_url": "https://www.youtube.com/watch?v=1234567890",
    "subteam_id": "123e4567-e89b-12d3-a456-426614174000",
    "prescreen_template_id": "123e4567-e89b-12d3-a456-426614174000",
    "structured_access_instructions": { … },
    "enable_send_report": true,
    "earliest_showing_date": "2024-10-12",
    "security_deposit_amount": 1000.21,
    "require_last_month_rent": true,
    "requires_voucher": false,
    "custom_application_url": "https://app.findigs.com/apply/unitid=70f51c4c-d708-402e-9a5f-bb6fd60b6cf2",
    "include_feedback_leasing_report": true,
    "year_built": 2020,
    "application_fee": 50
  }
]

Create or update a unit

Request

Create a new unit or update an existing one.

Insert vs Update

  • Insert: When no id is provided, a new unit will be created. Required fields for creation include address, property_type, target_rental_rate, and account_id.
  • Update: When an id is provided, an existing unit will be updated. No other fields are required.

Address Updates

When updating a unit, if you include the address field, you must provide all address components (street_number, street_name, zip_code, state, city). Partial address updates are not supported.

Structured Access Instructions

When providing structured_access_instructions, the showing_method field must also be set. The structure of the access instructions depends on the showing method:

  • For "Self Guided", "Remote Guided", or "Remote Guided with Gated Access" methods: Include fields like lockbox_location, lockbox_code, etc.
  • For "Accompanied" method: Include fields like assigned_user_ids, meeting_location, etc.
Security
BearerAuth
Bodyapplication/jsonrequired
One of:
idnumberrequired

Unit ID. If provided, the unit will be updated; if not, a new unit will be created.

Example: 3318
addressobject

Unit address. All fields must be provided together when updating.

property_typestring

Type of property

Enum"SINGLE FAMILY RESIDENCE""DUPLEX""TRIPLEX""MULTI-FAMILY""CONDO""TOWNHOUSE""ROOM""ADU"
Example: "TOWNHOUSE"
bedroomsnumber

Number of bedrooms

Example: 3
bathroomsnumber

Number of bathrooms

Example: 2
sqftnumber

Square footage of the unit

Example: 1378
furnishedboolean

Whether the unit is furnished

Example: false
renovatedstring

Whether the unit has been renovated

Example: "No"
num_parking_spotsnumber

Number of parking spots

Example: 2
laundrystring

Laundry options

Enum"In Unit""Shared""Coin-op""Hookups but no machines""Machines In Unit - Tenant Responsible""None"
Example: "In Unit"
target_rental_ratenumber

Target rental rate in dollars per month

Example: 1925
is_occupiedboolean

Whether the unit is currently occupied

Example: false
earliest_move_in_datestring(date)

Earliest date the unit is available for move-in

Example: "2024-10-12"
allow_cooperating_brokersboolean

Whether cooperating brokers are allowed

Example: true
desired_lease_duration_monthsArray of numbers

Desired lease duration in months

Example: [12]
pets_allowedstring

Pet policy

Enum"Yes""Yes with pet fee""No""Dogs only""Dogs only with pet fee""Cats only""Cats only with pet fee"
Example: "Yes with pet fee"
pet_restrictionsstring

Restrictions on pets

Example: "A MINIMUM NON-REFUNDABLE pet fee in the amount of $300 per pet is required"
hoa_detailsobject
key_accessstring

Key access information

Enum"Digital Lockbox Connected to RentEngine""Single code lockbox with key""Digital door lock with code""I will add this later""Accompanied Showing"
Example: "Digital door lock with code"
structured_access_instructionsSelf-guided/Remote showing instructions (object) or Accompanied Showing Instructions (object)

Structured access instructions that vary based on showing_method. When providing structured_access_instructions, showing_method must also be set.

One of:

Structured access instructions that vary based on showing_method. When providing structured_access_instructions, showing_method must also be set.

earliest_showing_datestring(date)

Earliest date the unit can be shown

Example: "2024-10-12"
additional_infostring

Additional information about the unit

Example: "Newly renovated kitchen"
min_resident_qualificationsstring

Minimum qualifications for residents

Example: "Credit score 650+, income 3x rent"
utilities_includedArray of strings

Utilities included in rent

Items Enum"Water""Sewer/Septic""Trash""Wifi/Internet""Cable/TV""Electricity""Gas""HOA""Lawn Care""Pool Service"
Example: ["Lawn Care","Trash"]
parking_typeArray of strings

Type of parking available

Items Enum"Street""Carport""Assigned Spots""Driveway""Shared Garage""Private Garage""Paid Parking""Parking Lot"
Example: ["Assigned Spots"]
statusstring

Current status of the unit

Enum"Incomplete""Available""On Hold""Leased""Archived""Withdrawn""Withdrawal Requested"
Example: "Available"
extracted_fromstring

Source of the unit data. Can be a any string. Essentially the same as an external_id. Uniqueness is not enforced.

Example: "f123abc"
marketing_descriptionstring

Marketing description of the unit

Example: "**AVAILABLE NOW** 3 Bedroom 2 Bathroom Townhome For Rent!"
marketing_photosArray of objects
commission_amountnumber

Commission amount

Example: 1
commission_typestring

Type of commission

Enum"percent""fixed""none""contact_mls_agent"
Example: "percent"
imported_bystring

Who/what imported the unit

Example: "API Import"
floor_numbernumber[ 0 .. 150 ]

Floor number of the unit

Example: 1
has_elevatorboolean

Whether the building has an elevator

Example: false
account_idstring

ID of the account that owns the unit

Example: "269bf205-d876-42f5-988d-6f40891df58a"
owner_emailsArray of strings

Email addresses of the owners

Example: ["owner@example.com"]
accepts_vouchersboolean

Whether the unit accepts housing vouchers

Example: true
showing_methodstring

Method for showing the unit

Enum"Accompanied""Remote Guided""Remote Guided with Gated Access""Self Guided"
Example: "Self Guided"
internal_notesstring

Internal notes about the unit

Example: "Garage work scheduled for Monday"
move_in_feesArray of objects
monthly_feesArray of objects
multifamily_property_idstring or null(uuid)

ID of the multifamily property. Pass string 'null' to clear this field.

Example: "421e4567-e89b-12d3-a456-426614174000"
floorplans_idstring or null(uuid)

ID of the floorplan. Pass string 'null' to clear this field.

Example: "451e4567-e89b-12d3-a456-426614174000"
video_urlstring

URL of video tour (such as YouTube, Vimeo, Zillow Tour, Matterport, Ricoh360, or zInspector tour)

Example: "https://www.youtube.com/watch?v=1234567890"
subteam_idstring or null(uuid)

ID of the subteam managing the unit. Pass string 'null' to clear this field.

Example: "123e4567-e89b-12d3-a456-426614174000"
prescreen_template_idstring(uuid)

ID of the prescreening template to use for this unit

Example: "123e4567-e89b-12d3-a456-426614174000"
enable_send_reportboolean

Whether to enable sending reports

Example: true
security_deposit_amountnumber

Amount of security deposit in dollars

Example: 1000
require_last_month_rentboolean

Whether last month's rent is required upfront

Example: true
requires_voucherboolean

Whether a voucher is required

Example: false
include_feedback_leasing_reportboolean

Whether to include feedback in leasing reports

Example: true
year_builtnumber>= 1800

Year the property was built

Example: 2020
after_upsert_actionobject

Actions to perform after updating the unit

application_feenumber>= 0

Application fee amount in dollars

Example: 50
curl -i -X POST \
  https://rentengine.redocly.app/_mock/openapi/units \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 3318,
    "address": {
      "street_number": "123",
      "street_name": "Main St",
      "unit": "4B",
      "zip_code": "12345",
      "state": "CA",
      "country": "United States",
      "city": "San Francisco"
    },
    "property_type": "TOWNHOUSE",
    "bedrooms": 3,
    "bathrooms": 2,
    "sqft": 1378,
    "furnished": false,
    "renovated": "No",
    "num_parking_spots": 2,
    "laundry": "In Unit",
    "target_rental_rate": 1925,
    "is_occupied": false,
    "earliest_move_in_date": "2024-10-12",
    "allow_cooperating_brokers": true,
    "desired_lease_duration_months": [
      12
    ],
    "pets_allowed": "Yes with pet fee",
    "pet_restrictions": "A MINIMUM NON-REFUNDABLE pet fee in the amount of $300 per pet is required",
    "hoa_details": {
      "isInHOA": true,
      "hoaAppRequired": true,
      "hoaAppFee": 100,
      "hoaApplicationUrl": "https://example.com/application",
      "hoaApprovalTimeframe": "2 weeks",
      "hoaAmenities": [
        "Pool",
        "Gym",
        "Clubhouse"
      ]
    },
    "key_access": "Digital door lock with code",
    "structured_access_instructions": {
      "lockbox_location": "Front Door",
      "lockbox_code": "1234",
      "private_gate": "Gate code: 5678",
      "community_gate": "Gate code: 9012",
      "anything_else": "Please close the gate behind you"
    },
    "earliest_showing_date": "2024-10-12",
    "additional_info": "Newly renovated kitchen",
    "min_resident_qualifications": "Credit score 650+, income 3x rent",
    "utilities_included": [
      "Lawn Care",
      "Trash"
    ],
    "parking_type": [
      "Assigned Spots"
    ],
    "status": "Available",
    "extracted_from": "f123abc",
    "marketing_description": "**AVAILABLE NOW** 3 Bedroom 2 Bathroom Townhome For Rent!",
    "marketing_photos": [
      {
        "path": "https://example.com/images/unit123.jpg",
        "hidden": false,
        "original": "https://example.com/images/unit123_original.jpg"
      }
    ],
    "commission_amount": 1,
    "commission_type": "percent",
    "imported_by": "API Import",
    "floor_number": 1,
    "has_elevator": false,
    "account_id": "269bf205-d876-42f5-988d-6f40891df58a",
    "owner_emails": [
      "owner@example.com"
    ],
    "accepts_vouchers": true,
    "showing_method": "Self Guided",
    "internal_notes": "Garage work scheduled for Monday",
    "move_in_fees": [
      {
        "type": "dollar",
        "amount": 150,
        "name": "Admin Fee"
      }
    ],
    "monthly_fees": [
      {
        "type": "dollar",
        "amount": 50,
        "name": "Pet Fee"
      }
    ],
    "multifamily_property_id": "421e4567-e89b-12d3-a456-426614174000",
    "floorplans_id": "451e4567-e89b-12d3-a456-426614174000",
    "video_url": "https://www.youtube.com/watch?v=1234567890",
    "subteam_id": "123e4567-e89b-12d3-a456-426614174000",
    "prescreen_template_id": "123e4567-e89b-12d3-a456-426614174000",
    "enable_send_report": true,
    "security_deposit_amount": 1000,
    "require_last_month_rent": true,
    "requires_voucher": false,
    "include_feedback_leasing_report": true,
    "year_built": 2020,
    "after_upsert_action": {
      "action": "cancel_scheduled_bookings",
      "should_cancel_scheduled_bookings": true,
      "custom_sms_message": "Hi, the unit is available for showing. Please contact us at (555) 123-4567 with any questions."
    },
    "application_fee": 50
  }'

Responses

Unit successfully created or updated

Bodyapplication/json
unitobject(Unit)
Response
application/json
{
  "unit": {
    "id": 3318,
    "created_at": "2024-10-05T18:53:03.406168Z",
    "updated_at": "2024-10-05T18:53:03.406168Z",
    "address": 957,
    "property_type": "TOWNHOUSE",
    "bedrooms": "3",
    "bathrooms": "2",
    "sqft": "1378",
    "furnished": false,
    "renovated": "No",
    "num_parking_spots": "2",
    "laundry": "In Unit",
    "target_rental_rate": "1925",
    "is_occupied": false,
    "earliest_move_in_date": "2024-10-12",
    "allow_cooperating_brokers": true,
    "desired_lease_duration_months": [ … ],
    "pets_allowed": "Yes with pet fee",
    "pet_restrictions": "A MINIMUM NON-REFUNDABLE pet fee in the amount of $300 per pet is required",
    "hoa_app_required": true,
    "hoa_app_fee": 100,
    "hoa_application_url": "https://example.com/application",
    "key_access": "I will add this later",
    "access_instructions": "Lockbox/Door Code: Tenant Turner",
    "min_resident_qualifications": "",
    "utilities_included": [ … ],
    "parking_type": [ … ],
    "storm_protection": "None",
    "status": "Leased",
    "send_showing_notifications": true,
    "send_leasing_update_email": true,
    "extracted_from": "f123abc",
    "marketing_description": "**AVAILABLE NOW** 3 Bedroom 2 Bathroom Townhome For Rent in Meadow Woods!",
    "marketing_photos": [ … ],
    "commission_amount": "1",
    "commission_type": "none",
    "imported_by": "Rentvine Sync",
    "floor_number": 1,
    "has_elevator": false,
    "hoa_details": { … },
    "account_id": "269bf205-d876-42f5-988d-6f40891df58a",
    "owner_emails": [ … ],
    "accepts_vouchers": true,
    "internal_notes": "Garage work scheduled for Monday.",
    "amenities": [ … ],
    "monthly_fees": [ … ],
    "move_in_fees": [ … ],
    "multifamily_property_id": "421e4567-e89b-12d3-a456-426614174000",
    "showing_method": "Remote Guided",
    "floorplans_id": "451e4567-e89b-12d3-a456-426614174000",
    "video_url": "https://www.youtube.com/watch?v=1234567890",
    "subteam_id": "123e4567-e89b-12d3-a456-426614174000",
    "prescreen_template_id": "123e4567-e89b-12d3-a456-426614174000",
    "structured_access_instructions": { … },
    "enable_send_report": true,
    "earliest_showing_date": "2024-10-12",
    "security_deposit_amount": 1000.21,
    "require_last_month_rent": true,
    "requires_voucher": false,
    "custom_application_url": "https://app.findigs.com/apply/unitid=70f51c4c-d708-402e-9a5f-bb6fd60b6cf2",
    "include_feedback_leasing_report": true,
    "year_built": 2020,
    "application_fee": 50
  }
}

UnitsWebhook

Request

Webhook for unit changes (creates, updates, deletes). Only the below fields are included in the record and old_record objects.

Security
ApiKeyAuth
Bodyapplication/json
One of:

Generic structure of webhook payloads

typestringrequired

Type of event

Value"INSERT"
Example: "INSERT"
tablestringrequired

Name of the table where the event occurred

Example: "lockbox_events"
recordobjectrequired

The newly created record

Example: {"id":"123e4567-e89b-12d3-a456-426614174000","lockbox_id":"123e4567-e89b-12d3-a456-426614174001","event_type":"Install","unit_id":"12345","created_at":"2023-01-15T12:30:00Z","data":null}
record.​idinteger

Unique identifier for the unit

Example: "123e4567-e89b-12d3-a456-426614174000"
record.​property_typestring

Type of property

Example: "TOWNHOUSE"
record.​highlighted_amenitiesArray of strings

Highlighted amenities

record.​bedroomsstring

Number of bedrooms

Example: "3"
record.​bathroomsstring

Number of bathrooms

Example: "2"
record.​sqftstring

Square footage of the unit

Example: "1378"
record.​furnishedboolean

Whether the unit is furnished

Example: false
record.​renovatedstring

Whether the unit has been renovated

Example: "No"
record.​num_parking_spotsstring

Number of parking spots

Example: "2"
record.​laundrystring

Laundry options

Example: "In Unit"
record.​target_rental_ratestring

Target rental rate for the unit in dollars per month

Example: "1925"
record.​is_occupiedboolean

Whether the unit is currently occupied

Example: false
record.​earliest_move_in_datestring(date)

Earliest date the unit is available for move-in

Example: "2024-10-12"
record.​allow_cooperating_brokersboolean or null

Whether cooperating brokers are allowed

Example: true
record.​desired_lease_duration_monthsArray of integers

Desired lease duration in months

Example: [12]
record.​pets_allowedstring or null

Pet policy

Example: "Yes with pet fee"
record.​pet_restrictionsstring

Restrictions on pets

Example: "A MINIMUM NON-REFUNDABLE pet fee in the amount of $300 per pet is required"
record.​hoa_app_requiredboolean or null

Whether HOA application is required

Example: true
record.​hoa_app_feenumber or null

HOA application fee in dollars

Example: 100
record.​hoa_application_urlstring or null

URL for HOA application

Example: "https://example.com/application"
record.​key_accessstring

Key access information

Example: "I will add this later"
record.​structured_access_instructionsobject

Structured access instructions

record.​earliest_showing_datestring(date)

Earliest date the unit can be shown

Example: "2024-10-12"
record.​min_resident_qualificationsstring

Minimum qualifications for residents

Example: ""
record.​utilities_includedArray of strings

Utilities included in rent

Example: ["Lawn Care","Trash"]
record.​parking_typeArray of strings

Type of parking available

Example: ["Assigned Spots"]
record.​statusstring

Current status of the unit

Example: "Leased"
record.​extracted_fromstring

Source of the unit data

Example: "f123abc"
record.​marketing_descriptionstring

Marketing description of the unit

Example: "**AVAILABLE NOW** 3 Bedroom 2 Bathroom Townhome For Rent in Meadow Woods!"
record.​marketing_photosArray of objects

Photos of the unit

record.​commission_amountstring

Commission amount

Example: "1"
record.​commission_typestring

Type of commission

Example: "none"
record.​imported_bystring or null

Who/what imported the unit

Example: "Rentvine Sync"
record.​floor_numberinteger

Floor number of the unit

Example: 1
record.​has_elevatorboolean or null

Whether the building has an elevator

Example: false
record.​hoa_detailsobject

Details about the HOA

record.​account_idstring

ID of the account that owns the unit

Example: "269bf205-d876-42f5-988d-6f40891df58a"
record.​owner_emailsArray of strings

Email addresses of the owners

Example: ["rick@amgrents.com"]
record.​accepts_vouchersboolean or null

Whether the unit accepts housing vouchers.

Example: true
record.​showing_methodstring or null

Method for showing the unit

Example: "Remote Guided"
record.​amenitiesArray of strings

All amenities of the unit

Example: ["Dishwasher","Stove","Range Oven","Refrigerator"]
record.​internal_notesstring or null

Internal notes about the unit.

Example: "Garage work scheduled for Monday."
record.​move_in_feesArray of objects or null

Fees required at move-in

record.​monthly_feesArray of objects or null

Monthly recurring fees

record.​multifamily_property_idstring or null

ID of the multifamily property

Example: "421e4567-e89b-12d3-a456-426614174000"
record.​floorplans_idstring or null

ID of the floorplan

Example: "451e4567-e89b-12d3-a456-426614174000"
record.​video_urlstring or null

URL of video tour

Example: "https://www.youtube.com/watch?v=1234567890"
record.​subteam_idstring or null

ID of the subteam managing the unit

Example: "123e4567-e89b-12d3-a456-426614174000"
record.​prescreen_template_idstring or null

ID of the prescreening template to use for this unit

Example: "123e4567-e89b-12d3-a456-426614174000"
record.​enable_send_reportboolean

Whether to enable sending reports

Example: true
record.​security_deposit_amountnumber or null

Amount of security deposit in dollars

Example: 1000.21
record.​require_last_month_rentboolean or null

Whether last month's rent is required upfront

Example: true
record.​requires_voucherboolean or null

Whether a voucher is required

Example: false
record.​custom_application_urlstring

URL for custom application

Example: "https://app.findigs.com/apply/unitid=70f51c4c-d708-402e-9a5f-bb6fd60b6cf2"
record.​include_feedback_leasing_reportboolean

Whether to include feedback in leasing reports

Example: true
record.​year_builtnumber or null

Year the property was built

Example: 2020
record.​application_feenumber or null

Application fee amount in dollars

Example: 50
record.​created_atstring(date-time)

Timestamp when the unit was created

Example: "2023-01-15T12:30:00Z"
record.​updated_atstring(date-time)

Timestamp when the unit was last updated

Example: "2024-10-05T18:53:03.406168Z"
old_recordobjectrequired

Always null for INSERT events

Example: null
old_record.​idinteger

Unique identifier for the unit

Example: 3318
old_record.​property_typestring

Type of property

Example: "TOWNHOUSE"
old_record.​highlighted_amenitiesArray of strings

Highlighted amenities

old_record.​bedroomsstring

Number of bedrooms

Example: "3"
old_record.​bathroomsstring

Number of bathrooms

Example: "2"
old_record.​sqftstring

Square footage of the unit

Example: "1378"
old_record.​furnishedboolean

Whether the unit is furnished

Example: false
old_record.​renovatedstring

Whether the unit has been renovated

Example: "No"
old_record.​num_parking_spotsstring

Number of parking spots

Example: "2"
old_record.​laundrystring

Laundry options

Example: "In Unit"
old_record.​target_rental_ratestring

Target rental rate for the unit in dollars per month

Example: "1925"
old_record.​is_occupiedboolean

Whether the unit is currently occupied

Example: false
old_record.​earliest_move_in_datestring(date)

Earliest date the unit is available for move-in

Example: "2024-10-12"
old_record.​allow_cooperating_brokersboolean or null

Whether cooperating brokers are allowed

Example: true
old_record.​desired_lease_duration_monthsArray of integers

Desired lease duration in months

Example: [12]
old_record.​pets_allowedstring or null

Pet policy

Example: "Yes with pet fee"
old_record.​pet_restrictionsstring

Restrictions on pets

Example: "A MINIMUM NON-REFUNDABLE pet fee in the amount of $300 per pet is required"
old_record.​hoa_app_requiredboolean or null

Whether HOA application is required

Example: true
old_record.​hoa_app_feenumber or null

HOA application fee in dollars

Example: 100
old_record.​hoa_application_urlstring or null

URL for HOA application

Example: "https://example.com/application"
old_record.​key_accessstring

Key access information

Example: "I will add this later"
old_record.​structured_access_instructionsobject

Structured access instructions

old_record.​earliest_showing_datestring(date)

Earliest date the unit can be shown

Example: "2024-10-12"
old_record.​min_resident_qualificationsstring

Minimum qualifications for residents

Example: ""
old_record.​utilities_includedArray of strings

Utilities included in rent

Example: ["Lawn Care","Trash"]
old_record.​parking_typeArray of strings

Type of parking available

Example: ["Assigned Spots"]
old_record.​statusstring

Current status of the unit

Example: "Leased"
old_record.​extracted_fromstring

Source of the unit data

Example: "f123abc"
old_record.​marketing_descriptionstring

Marketing description of the unit

Example: "**AVAILABLE NOW** 3 Bedroom 2 Bathroom Townhome For Rent in Meadow Woods!"
old_record.​marketing_photosArray of objects

Photos of the unit

old_record.​commission_amountstring

Commission amount

Example: "1"
old_record.​commission_typestring

Type of commission

Example: "none"
old_record.​imported_bystring or null

Who/what imported the unit

Example: "Rentvine Sync"
old_record.​floor_numberinteger

Floor number of the unit

Example: 1
old_record.​has_elevatorboolean or null

Whether the building has an elevator

Example: false
old_record.​hoa_detailsobject

Details about the HOA

old_record.​account_idstring

ID of the account that owns the unit

Example: "269bf205-d876-42f5-988d-6f40891df58a"
old_record.​owner_emailsArray of strings

Email addresses of the owners

Example: ["rick@amgrents.com"]
old_record.​accepts_vouchersboolean or null

Whether the unit accepts housing vouchers.

Example: true
old_record.​showing_methodstring or null

Method for showing the unit

Example: "Remote Guided"
old_record.​amenitiesArray of strings

All amenities of the unit

Example: ["Dishwasher","Stove","Range Oven","Refrigerator"]
old_record.​internal_notesstring or null

Internal notes about the unit.

Example: "Garage work scheduled for Monday."
old_record.​move_in_feesArray of objects or null

Fees required at move-in

old_record.​monthly_feesArray of objects or null

Monthly recurring fees

old_record.​multifamily_property_idstring or null

ID of the multifamily property

Example: "421e4567-e89b-12d3-a456-426614174000"
old_record.​floorplans_idstring or null

ID of the floorplan

Example: "451e4567-e89b-12d3-a456-426614174000"
old_record.​video_urlstring or null

URL of video tour

Example: "https://www.youtube.com/watch?v=1234567890"
old_record.​subteam_idstring or null

ID of the subteam managing the unit

Example: "123e4567-e89b-12d3-a456-426614174000"
old_record.​prescreen_template_idstring or null

ID of the prescreening template to use for this unit

Example: "123e4567-e89b-12d3-a456-426614174000"
old_record.​enable_send_reportboolean

Whether to enable sending reports

Example: true
old_record.​security_deposit_amountnumber or null

Amount of security deposit in dollars

Example: 1000.21
old_record.​require_last_month_rentboolean or null

Whether last month's rent is required upfront

Example: true
old_record.​requires_voucherboolean or null

Whether a voucher is required

Example: false
old_record.​custom_application_urlstring

URL for custom application

Example: "https://app.findigs.com/apply/unitid=70f51c4c-d708-402e-9a5f-bb6fd60b6cf2"
old_record.​include_feedback_leasing_reportboolean

Whether to include feedback in leasing reports

Example: true
old_record.​year_builtnumber or null

Year the property was built

Example: 2020
old_record.​application_feenumber or null

Application fee amount in dollars

Example: 50
old_record.​created_atstring(date-time)

Timestamp when the unit was created

Example: "2024-10-05T18:53:03.406168Z"
old_record.​updated_atstring(date-time)

Timestamp when the unit was last updated

Example: "2024-10-05T18:53:03.406168Z"
application/json
{
  "type": "INSERT",
  "table": "lockbox_events",
  "record": {
    "id": 3318,
    "lockbox_id": "123e4567-e89b-12d3-a456-426614174001",
    "event_type": "Install",
    "unit_id": "12345",
    "created_at": "2024-10-05T18:53:03.406168Z",
    "data": null,
    "property_type": "TOWNHOUSE",
    "highlighted_amenities": [ … ],
    "bedrooms": "3",
    "bathrooms": "2",
    "sqft": "1378",
    "furnished": false,
    "renovated": "No",
    "num_parking_spots": "2",
    "laundry": "In Unit",
    "target_rental_rate": "1925",
    "is_occupied": false,
    "earliest_move_in_date": "2024-10-12",
    "allow_cooperating_brokers": true,
    "desired_lease_duration_months": [ … ],
    "pets_allowed": "Yes with pet fee",
    "pet_restrictions": "A MINIMUM NON-REFUNDABLE pet fee in the amount of $300 per pet is required",
    "hoa_app_required": true,
    "hoa_app_fee": 100,
    "hoa_application_url": "https://example.com/application",
    "key_access": "I will add this later",
    "structured_access_instructions": {},
    "earliest_showing_date": "2024-10-12",
    "min_resident_qualifications": "",
    "utilities_included": [ … ],
    "parking_type": [ … ],
    "status": "Leased",
    "extracted_from": "f123abc",
    "marketing_description": "**AVAILABLE NOW** 3 Bedroom 2 Bathroom Townhome For Rent in Meadow Woods!",
    "marketing_photos": [ … ],
    "commission_amount": "1",
    "commission_type": "none",
    "imported_by": "Rentvine Sync",
    "floor_number": 1,
    "has_elevator": false,
    "hoa_details": {},
    "account_id": "269bf205-d876-42f5-988d-6f40891df58a",
    "owner_emails": [ … ],
    "accepts_vouchers": true,
    "showing_method": "Remote Guided",
    "amenities": [ … ],
    "internal_notes": "Garage work scheduled for Monday.",
    "move_in_fees": [ … ],
    "monthly_fees": [ … ],
    "multifamily_property_id": "421e4567-e89b-12d3-a456-426614174000",
    "floorplans_id": "451e4567-e89b-12d3-a456-426614174000",
    "video_url": "https://www.youtube.com/watch?v=1234567890",
    "subteam_id": "123e4567-e89b-12d3-a456-426614174000",
    "prescreen_template_id": "123e4567-e89b-12d3-a456-426614174000",
    "enable_send_report": true,
    "security_deposit_amount": 1000.21,
    "require_last_month_rent": true,
    "requires_voucher": false,
    "custom_application_url": "https://app.findigs.com/apply/unitid=70f51c4c-d708-402e-9a5f-bb6fd60b6cf2",
    "include_feedback_leasing_report": true,
    "year_built": 2020,
    "application_fee": 50,
    "updated_at": "2024-10-05T18:53:03.406168Z"
  },
  "old_record": {
    "id": 3318,
    "property_type": "TOWNHOUSE",
    "highlighted_amenities": [ … ],
    "bedrooms": "3",
    "bathrooms": "2",
    "sqft": "1378",
    "furnished": false,
    "renovated": "No",
    "num_parking_spots": "2",
    "laundry": "In Unit",
    "target_rental_rate": "1925",
    "is_occupied": false,
    "earliest_move_in_date": "2024-10-12",
    "allow_cooperating_brokers": true,
    "desired_lease_duration_months": [ … ],
    "pets_allowed": "Yes with pet fee",
    "pet_restrictions": "A MINIMUM NON-REFUNDABLE pet fee in the amount of $300 per pet is required",
    "hoa_app_required": true,
    "hoa_app_fee": 100,
    "hoa_application_url": "https://example.com/application",
    "key_access": "I will add this later",
    "structured_access_instructions": {},
    "earliest_showing_date": "2024-10-12",
    "min_resident_qualifications": "",
    "utilities_included": [ … ],
    "parking_type": [ … ],
    "status": "Leased",
    "extracted_from": "f123abc",
    "marketing_description": "**AVAILABLE NOW** 3 Bedroom 2 Bathroom Townhome For Rent in Meadow Woods!",
    "marketing_photos": [ … ],
    "commission_amount": "1",
    "commission_type": "none",
    "imported_by": "Rentvine Sync",
    "floor_number": 1,
    "has_elevator": false,
    "hoa_details": {},
    "account_id": "269bf205-d876-42f5-988d-6f40891df58a",
    "owner_emails": [ … ],
    "accepts_vouchers": true,
    "showing_method": "Remote Guided",
    "amenities": [ … ],
    "internal_notes": "Garage work scheduled for Monday.",
    "move_in_fees": [ … ],
    "monthly_fees": [ … ],
    "multifamily_property_id": "421e4567-e89b-12d3-a456-426614174000",
    "floorplans_id": "451e4567-e89b-12d3-a456-426614174000",
    "video_url": "https://www.youtube.com/watch?v=1234567890",
    "subteam_id": "123e4567-e89b-12d3-a456-426614174000",
    "prescreen_template_id": "123e4567-e89b-12d3-a456-426614174000",
    "enable_send_report": true,
    "security_deposit_amount": 1000.21,
    "require_last_month_rent": true,
    "requires_voucher": false,
    "custom_application_url": "https://app.findigs.com/apply/unitid=70f51c4c-d708-402e-9a5f-bb6fd60b6cf2",
    "include_feedback_leasing_report": true,
    "year_built": 2020,
    "application_fee": 50,
    "created_at": "2024-10-05T18:53:03.406168Z",
    "updated_at": "2024-10-05T18:53:03.406168Z"
  }
}

Responses

Successful operation

Bodyapplication/json
successboolean
Example: true
Response
application/json
{
  "success": true
}

Prospects

Events related to prospective tenants

OperationsWebhooks

Multifamily Properties

Operations for managing multifamily properties. Multifamily properties are used to syndicate large properties with paid advertising contracts to the paid rental feeds. For example, paid adverising contracts are required for the Zillow network if the building has more than 24 units, and for the Apartments.com if the building has more than 4 units. Other ILSs have different thresholds.

Operations

Floorplans

Operations for managing floorplans associated with multifamily properties. Floorplans are used to syndicate units to the paid rental feeds for paid advertising contracts. They must be used in conjunction with a multifamily property.

Operations

Leasing Events

Events related to leasing events

OperationsWebhooks

Subteams

Operations for managing subteams

Operations

Prescreening Templates

Operations for managing prescreening templates used for prospect qualification

Operations

Showings

Operations for managing showing availability and scheduling

Operations