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

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

Get unit showing availability

Request

Retrieve showing availability for a specific unit, including available and preferred showing windows

Security
BearerAuth
Query
unitIdnumberrequired

ID of the unit to get availability for

Example: unitId=12345
curl -i -X GET \
  'https://rentengine.redocly.app/_mock/openapi/showings/availability?unitId=12345' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success. Returns showing availability for the unit.

Bodyapplication/json
availabilityobject(UnitShowingAvailability)
Response
application/json
{
  "availability": {
    "unitId": 12345,
    "preferredShowingWindows": [ … ],
    "availableShowingWindows": [ … ],
    "showingMethod": "Accompanied",
    "timezoneName": "America/Chicago",
    "timezoneAbbreviation": "CST",
    "unitStatus": "Available"
  }
}

Create a showing

Request

Create a new showing for a unit. This endpoint handles both new showings and rescheduling of existing showings.

Prospect Types

  • Self: Regular prospect who needs to complete prescreening
  • Agent: Real estate agent who needs to provide a valid agent token

Prescreening

For self prospects, the system will automatically run prescreening based on the unit's prescreen template. If prescreening fails, the showing will not be created and an appropriate error will be returned.

Agent Tokens

For agent prospects, a valid 6-character agent token must be provided in the agentTk field.

Showing Methods

The desiredShowingMethod field allows specifying the preferred showing method:

  • "Accompanied": Agent-guided showing
  • "Self Guided": Self-guided showing
  • "Remote Guided": Remote-guided showing
  • "Remote Guided with Gated Access": Remote-guided showing with gate access
Security
BearerAuth
Bodyapplication/jsonrequired
unitIdnumberrequired

ID of the unit to schedule the showing for

Example: 12345
plannedForTimestring(date-time)required

Planned date and time for the showing (ISO 8601 format)

Example: "2024-03-15T10:00:00Z"
prospectDataobject(ProspectData)required

Prospect information and prescreening data

prospectData.​firstNamestringrequired

Prospect's first name

Example: "John"
prospectData.​lastNamestringrequired

Prospect's last name

Example: "Doe"
prospectData.​emailstringrequired

Prospect's email address

Example: "john.doe@example.com"
prospectData.​phonestringrequired

Prospect's phone number (10 digits)

Example: "5551234567"
prospectData.​creditScorestringrequired

Prospect's credit score range

Example: "700+"
prospectData.​incomestringrequired

Prospect's household monthly income range

Example: "$5000-$6000/month"
prospectData.​questionAnswersArray of objects(PrescreenQuestionAnswer)required

Answers to prescreening questions

prospectData.​questionAnswers[].​questionstringrequired

The question text

Example: "Do you have a housing voucher (e.g. Section 8)?"
prospectData.​questionAnswers[].​fixedQuestionTypestring

Fixed question type identifier

Example: "housing_voucher"
prospectData.​questionAnswers[].​typestringrequired

Question type

Example: "yes_no"
prospectData.​questionAnswers[].​answerbooleanrequired

The prospect's answer to the question

Example: false
prospectData.​prospectTypestringrequired

Type of prospect

Enum"Self""Agent"
Example: "Self"
prospectData.​voucherHolderboolean

Whether the prospect holds a housing voucher

Example: false
prospectData.​licenseNumberstring

License number (for agent prospects)

Example: "ABC123"
prospectData.​notesstring

Additional notes about the prospect

Example: "Interested in 2BR units"
agentTkstring

Agent token (required for agent prospects, must be 6 characters)

Example: "ABC123"
desiredShowingMethodstring

Preferred showing method

Enum"Accompanied""Self Guided""Remote Guided""Remote Guided with Gated Access"
Example: "Accompanied"
filesArray of strings

Array of file paths for uploaded documents

Example: ["documents/id-verification.pdf"]
livenessResultobject

Liveness verification result from ID verification

rescheduleEventstring or number

ID of the event to reschedule (if rescheduling an existing showing)

Example: 67890
curl -i -X POST \
  https://rentengine.redocly.app/_mock/openapi/showings/create \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "unitId": 12345,
    "plannedForTime": "2024-03-15T10:00:00Z",
    "prospectData": {
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phone": "5551234567",
      "creditScore": "700+",
      "income": "$5000-$6000/month",
      "questionAnswers": [
        {
          "question": "Do you have a housing voucher (e.g. Section 8)?",
          "fixedQuestionType": "housing_voucher",
          "type": "yes_no",
          "answer": false
        },
        {
          "question": "Have you been convicted of a felony?",
          "type": "yes_no",
          "answer": false
        }
      ],
      "prospectType": "Self",
      "voucherHolder": false
    },
    "desiredShowingMethod": "Accompanied"
  }'

Responses

Showing created successfully

Bodyapplication/json
statusTextstringrequired

Success status message

Example: "success"
Response
application/json
{
  "statusText": "success"
}