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

Prospects

Events related to prospective tenants

OperationsWebhooks

Get prospects

Request

Retrieve prospects with optional filtering and pagination

Security
BearerAuth
Query
idnumber

Filter by prospect ID

Example: id=123
account_idstring(uuid)

Filter by prospects associated with a specific RentEngine account by the account's id

Example: account_id=4b88ff32-8ba0-4bbf-8e60-c789909ac176
units_of_interestArray of numbers

Filter by prospects interested in specific units (comma-separated list of unit IDs)

Example: units_of_interest=123,124
statusstring

Filter prospects by status

Example: status=Showing Scheduled
sourcestring

Filter prospects by source

Example: source=Zillow
created_afterstring(date-time)

Filter prospects created after this timestamp (ISO 8601 format)

Example: created_after=2023-01-15T12:00:00Z
created_beforestring(date-time)

Filter prospects created before this timestamp (ISO 8601 format)

Example: created_before=2023-01-17T12:00:00Z
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/prospects?id=123&account_id=4b88ff32-8ba0-4bbf-8e60-c789909ac176&units_of_interest=123%2C124&status=Showing+Scheduled&source=Zillow&created_after=2023-01-15T12%3A00%3A00Z&created_before=2023-01-17T12%3A00%3A00Z&limit=25&page_number=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success. Returns a list of prospects.

Bodyapplication/jsonArray [
idnumber

Unique identifier for the prospect

Example: 123
namestring or null

Prospect's name

Example: "John Doe"
emailstring or null

Prospect's email address

Example: "john@example.com"
phonestring or null

Prospect's phone number

Example: "+15551234567"
statusstring

Current status of the prospect

Example: "Showing Scheduled"
sourcestring or null

Where the prospect came from

Example: "Zillow"
unit_of_interestnumber

ID of the unit the prospect is interested in

Example: 123
notesstring or null

Notes about the prospect

Example: "Interested in 2BR units"
prescreenedboolean or null

Whether the prospect has been prescreened

Example: true
voucher_holderboolean or null

Whether the prospect holds a housing voucher

Example: false
normalized_phone_number_generatedstring or null

Normalized phone number if normalizable. Else null.

Example: "+15551234567"
license_numberstring or null

License number if applicable

Example: "ABC123"
prospect_typestring

Type of prospect

Enum"Self""Agent"
Example: "Self"
created_atstring(date-time)

When the prospect was created

Example: "2023-01-15T12:00:00Z"
updated_atstring(date-time)

When the prospect was last updated

Example: "2023-01-16T14:30:00Z"
]
Response
application/json
[
  {
    "id": 123,
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+15551234567",
    "status": "Showing Scheduled",
    "source": "Zillow",
    "unit_of_interest": 123,
    "notes": "Interested in 2BR units",
    "prescreened": true,
    "voucher_holder": false,
    "normalized_phone_number_generated": "+15551234567",
    "license_number": "ABC123",
    "prospect_type": "Self",
    "created_at": "2023-01-15T12:00:00Z",
    "updated_at": "2023-01-16T14:30:00Z"
  }
]

ProspectsWebhook

Request

Webhook for prospect 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.​idstring(uuid)

Unique identifier for the prospect

Example: "123e4567-e89b-12d3-a456-426614174000"
record.​created_atstring(date-time)

When the prospect was created

Example: "2023-01-15T12:30:00Z"
record.​namestring

Prospect's name

Example: "John Doe"
record.​phonestring

Prospect's phone number

Example: "+15551234567"
record.​emailstring

Prospect's email address

Example: "test@gmail.com"
record.​unit_of_intereststring

Unit the prospect is interested in

Example: "123"
record.​statusstring

Current status of the prospect

Example: "Showing Scheduled"
record.​sourcestring

Where the prospect came from

Example: "Zillow"
record.​notesstring

Notes about the prospect

Example: "Interested in 2BR units"
record.​prescreenedboolean

Whether the prospect has been prescreened

Example: true
record.​voucher_holderboolean

Whether the prospect holds a housing voucher

Example: false
record.​normalized_phone_number_generatedstring

Normalized phone number if normalizable. Else null.

Example: "+15551234567"
record.​license_numberstring

License number if applicable

Example: "ABC123"
record.​prospect_typestring

Type of prospect

Enum"Self""Agent"
Example: "Agent"
record.​updated_atstring(date-time)

When the prospect was last updated

Example: "2023-01-16T14:30:00Z"
record.​assigned_to_user_idsArray of strings(uuid)

IDs of users assigned to this prospect

Example: ["123e4567-e89b-12d3-a456-426614174001"]
old_recordobjectrequired

Always null for INSERT events

Example: null
old_record.​idstring(uuid)

Unique identifier for the prospect

Example: "123e4567-e89b-12d3-a456-426614174000"
old_record.​created_atstring(date-time)

When the prospect was created

Example: "2023-01-15T12:00:00Z"
old_record.​namestring

Prospect's name

Example: "John Doe"
old_record.​phonestring

Prospect's phone number

Example: "+15551234567"
old_record.​emailstring

Prospect's email address

Example: "john.doe@example.com"
old_record.​unit_of_intereststring

Unit the prospect is interested in

Example: "123"
old_record.​statusstring

Current status of the prospect

Example: "Not Interested"
old_record.​sourcestring

Where the prospect came from

Example: "RentEngine"
old_record.​notesstring

Notes about the prospect

Example: "Interested in 2BR units"
old_record.​prescreenedboolean

Whether the prospect has been prescreened

Example: false
old_record.​voucher_holderboolean

Whether the prospect holds a housing voucher

Example: false
old_record.​normalized_phone_number_generatedstring

Normalized phone number if normalizable. Else null.

Example: "+15551234567"
old_record.​license_numberstring

License number if applicable

Example: "null"
old_record.​prospect_typestring

Type of prospect

Enum"Self""Agent"
Example: "Self"
old_record.​updated_atstring(date-time)

When the prospect was last updated

Example: "2023-01-15T12:00:00Z"
old_record.​assigned_to_user_idsArray of strings(uuid)

IDs of users assigned to this prospect

Example: ["123e4567-e89b-12d3-a456-426614174001"]
application/json
{
  "type": "UPDATE",
  "table": "prospects",
  "record": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2023-01-15T12:00:00Z",
    "name": "John Doe",
    "phone": "+15551234567",
    "email": "john.doe@example.com",
    "unit_of_interest": "123",
    "status": "Not Interested",
    "source": "Zillow",
    "notes": "Interested in 2BR units",
    "prescreened": true,
    "voucher_holder": false,
    "normalized_phone_number_generated": "+15551234567",
    "license_number": "ABC123",
    "prospect_type": "Agent",
    "updated_at": "2023-01-16T14:30:00Z",
    "assigned_to_user_ids": [ … ]
  },
  "old_record": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2023-01-15T12:00:00Z",
    "name": "John Doe",
    "phone": "+15551234567",
    "email": "john.doe@example.com",
    "unit_of_interest": "123",
    "status": "Showing SCheduled",
    "source": "RentEngine",
    "notes": "Interested in 2BR units",
    "prescreened": false,
    "voucher_holder": false,
    "normalized_phone_number_generated": "+15551234567",
    "license_number": "null",
    "updated_at": "2023-01-15T12:00:00Z",
    "prospect_type": "Self",
    "assigned_to_user_ids": []
  }
}

Responses

Successful operation

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

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