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

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

Create leasing events

Request

Create one or more leasing events. Additional event types will be supported in future releases. Currently only Assign to User events are fully supported. When using the "Assign to User" event type the context object must include an assignedToUserIds array.

Security
BearerAuth
Bodyapplication/jsonrequired
eventsArray of objects= 1 itemsrequired

List of leasing events to create. Only 1 event is supported at a time.

events[].​prospect_idnumberrequired

ID of the prospect associated with the event

Example: 12345
events[].​event_typestringrequired

Type of leasing event. Currently only "Assign to User" is supported.

Example: "Assign to User"
events[].​sourcestring

Source of the leasing event

Enum"Phone Call""Text Message""Email""Facebook Message""WhatsApp""Other""Automation"
Example: "Other"
events[].​notesstring

Optional notes for the event

Example: "Assigning to primary agent"
events[].​contextobject

Additional context for the event. For "Assign to User" events the following fields are recognized:

  • assignedToUserIds (array[uuid], required)
  • applyActionInBulk (boolean) - This will apply the action to all prospects with the same phone number. This is helpful for bulk assigning all units that the prospect is interested in to a single agent in one request.
Example: {"assignedToUserIds":["1259ef6e-61ee-42cb-b6bd-7fe547569d7c"],"applyActionInBulk":false}
curl -i -X POST \
  https://rentengine.redocly.app/_mock/openapi/leasing_events \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "events": [
      {
        "prospect_id": 12345,
        "event_type": "Assign to User",
        "source": "Other",
        "notes": "Assigning to Alice",
        "context": {
          "assignedToUserIds": [
            "1259ef6e-61ee-42cb-b6bd-7fe547569d7c"
          ],
          "applyActionInBulk": false
        }
      }
    ]
  }'

Responses

Leasing events created successfully

Bodyapplication/jsonArray [
idinteger(int64)

Unique identifier for the leasing event

Example: 12345
created_atstring(date-time)

Timestamp when the leasing event was created

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

Optional notes about the leasing event

Example: "Reschedule"
prospectinteger(int64)

ID of the associated prospect

Example: 12345
planned_date_timestring(date-time)

Planned date and time for the leasing event

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

Source of the leasing event

Enum"Phone Call""Text Message""Email""Facebook Message""WhatsApp""Other""Showing Scheduler""Automation"
Example: "Phone Call"
event_typestring

Type of the leasing event

Enum"New""Contacted, Awaiting Information""Showing Desired""Showing Scheduled""Showing Complete""Missed Showing""Ghosting""Application Sent to Prospect""Application Received""Application Pending"
Example: "New"
next_follow_upstring(date-time)

Timestamp for the next follow-up

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

Flag indicating if the leasing event is deleted

Default false
Example: false
created_bystring

Identifier of the user who created the event

Example: "12345"
contextobject

Additional context information for the event. Structure varies based on event_type.

Example: {"assignedToUserIds":["1259ef6e-61ee-42cb-b6bd-7fe547569d7c"],"createdByUserRole":"Property Manager","previousAssignedToUserIds":[]}
]
Response
application/json
[
  {
    "id": 12345,
    "created_at": "2024-10-05T18:53:03.406168Z",
    "notes": "Reschedule",
    "prospect": 12345,
    "planned_date_time": "2024-10-05T18:53:03.406168Z",
    "source": "Phone Call",
    "event_type": "New",
    "next_follow_up": "2024-10-05T18:53:03.406168Z",
    "deleted": false,
    "created_by": "12345",
    "context": { … }
  }
]

Leasing eventsWebhook

Request

Webhook for leasing events (creates, updates, deletes). Leasing events of the following types are supported:

  • "New"
  • "Contacted, Awaiting Information"
  • "Showing Desired"
  • "Showing Scheduled"
  • "Showing Complete"
  • "Missed Showing"
  • "Ghosting"
  • "Application Sent to Prospect"
  • "Application Received"
  • "Application Pending"
  • "Application in Owner Review"
  • "Application Approved"
  • "Withdrawn"
  • "Application Rejected"
  • "Prescreen Submitted"
  • "Prescreen Rejected - Self reported credit"
  • "Prescreen Rejected - Self reported income"
  • "Prescreen Rejected - ID Verification"
  • "Prescreen Approved"
  • "Looking too early"
  • "Lease out for signing"
  • "Lease Signed"
  • "Deposit Received"
  • "Move-in Scheduled"
  • "Moved In"
  • "Unit of Interest Unavailable"
  • "Not Interested"
  • "Duplicate Lead"
  • "Still Deciding"
  • "HOA Application Sent To Prospect"
  • "HOA Application Submitted"
  • "HOA Application Approved"
  • "HOA Application Rejected"
  • "Showing Failed"
  • "Showing Canceled"
  • "Showing Confirmed"
  • "Arrived for Showing"
  • "Showing Started"
  • "Log Note"
  • "Assign to User"
  • "Blocklist Prospect"
  • "Unblock Prospect"
  • "Reassign Showing"
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}
old_recordnullrequired

Always null for INSERT events

Example: null
application/json
{
  "type": "INSERT",
  "table": "lockbox_events",
  "record": {
    "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
  },
  "old_record": null
}

Responses

Successful operation

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

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