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

Get multifamily properties

Request

Retrieve multifamily properties with optional filtering

Security
BearerAuth
Query
account_idstring(uuid)

Filter by account ID

Example: account_id=4b88ff32-8ba0-4bbf-8e60-c789909ac176
idstring(uuid)

Filter by multifamily property ID

Example: id=123e4567-e89b-12d3-a456-426614174000
deletedboolean

Filter by deleted status

Default false
curl -i -X GET \
  'https://rentengine.redocly.app/_mock/openapi/multifamily_properties?account_id=4b88ff32-8ba0-4bbf-8e60-c789909ac176&id=123e4567-e89b-12d3-a456-426614174000&deleted=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success. Returns a list of multifamily properties.

Bodyapplication/jsonArray [
idstring(uuid)required

Unique identifier for the multifamily property

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

Name of the multifamily community

Example: "Sunset Towers"
building_countinteger[ 1 .. 100 ]

Number of buildings in the property

Example: 3
unit_countinteger[ 1 .. 10000 ]

Total number of units in the property

Example: 75
descriptionstring

Description of the property

Example: "Luxury apartment community with amenities"
structure_typestring

Type of building structure

Enum"Mid Rise""High Rise""Garden Style"
Example: "Mid Rise"
year_builtinteger[ 1800 .. 2025 ]

Year the property was built

Example: 2008
photosArray of objects

Photos of the property

external_idsobject

External identifiers for the property

Example: {"mls_id":"MLS12345","yardi_id":"Y7890"}
text_addressstringrequired

Full text address of the property

Example: "123 Main St, San Francisco, CA 94111"
account_idstring(uuid)required

ID of the account that owns the property

Example: "4b88ff32-8ba0-4bbf-8e60-c789909ac176"
created_atstring(date-time)required

Timestamp when the property was created

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

Timestamp when the property was last updated

Example: "2023-01-16T14:30:00Z"
]
Response
application/json
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "community_name": "Sunset Towers",
    "building_count": 3,
    "unit_count": 75,
    "description": "Luxury apartment community with amenities",
    "structure_type": "Mid Rise",
    "year_built": 2008,
    "photos": [ … ],
    "external_ids": { … },
    "text_address": "123 Main St, San Francisco, CA 94111",
    "account_id": "4b88ff32-8ba0-4bbf-8e60-c789909ac176",
    "created_at": "2023-01-15T12:00:00Z",
    "updated_at": "2023-01-16T14:30:00Z"
  }
]

Create or update a multifamily property

Request

Create a new multifamily property or update an existing one

Security
BearerAuth
Bodyapplication/jsonrequired
idstring(uuid)

Unique identifier for the multifamily property. If provided, the property will be updated; if not, a new property will be created.

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

Name of the multifamily community

Example: "Sunset Towers"
building_countinteger[ 1 .. 100 ]required

Number of buildings in the property

Example: 3
unit_countinteger[ 1 .. 10000 ]required

Total number of units in the property

Example: 75
descriptionstring

Description of the property

Example: "Luxury apartment community with amenities"
structure_typestringrequired

Type of building structure

Enum"Mid Rise""High Rise""Garden Style"
Example: "Mid Rise"
year_builtinteger>= 1800required

Year the property was built

Example: 2008
photosArray of objectsrequired

Photos of the property

photos[].​pathstringrequired

URL or path to the property photo

Example: "https://example.com/images/sunset-towers.jpg"
photos[].​hiddenbooleanrequired

Whether the photo is hidden

Example: false
external_idsobject

External identifiers for the property

Example: {"mls_id":"MLS12345","yardi_id":"Y7890"}
text_addressstringrequired

Full text address of the property

Example: "123 Main St, San Francisco, CA 94111"
account_idstring(uuid)required

ID of the account that owns the property. Must be a valid account ID that the API key has access to.

Example: "4b88ff32-8ba0-4bbf-8e60-c789909ac176"
deletedboolean

Whether the property is deleted

Default false
Example: false
curl -i -X POST \
  https://rentengine.redocly.app/_mock/openapi/multifamily_properties \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "community_name": "Sunset Towers",
    "building_count": 3,
    "unit_count": 75,
    "description": "Luxury apartment community with amenities",
    "structure_type": "Mid Rise",
    "year_built": 2008,
    "photos": [
      {
        "path": "https://example.com/images/sunset-towers.jpg",
        "hidden": false
      }
    ],
    "text_address": "123 Main St, San Francisco, CA 94111",
    "account_id": "4b88ff32-8ba0-4bbf-8e60-c789909ac176"
  }'

Responses

Multifamily property successfully created or updated

Bodyapplication/jsonArray [
idstring(uuid)required

Unique identifier for the multifamily property

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

Name of the multifamily community

Example: "Sunset Towers"
building_countinteger[ 1 .. 100 ]

Number of buildings in the property

Example: 3
unit_countinteger[ 1 .. 10000 ]

Total number of units in the property

Example: 75
descriptionstring

Description of the property

Example: "Luxury apartment community with amenities"
structure_typestring

Type of building structure

Enum"Mid Rise""High Rise""Garden Style"
Example: "Mid Rise"
year_builtinteger[ 1800 .. 2025 ]

Year the property was built

Example: 2008
photosArray of objects

Photos of the property

external_idsobject

External identifiers for the property

Example: {"mls_id":"MLS12345","yardi_id":"Y7890"}
text_addressstringrequired

Full text address of the property

Example: "123 Main St, San Francisco, CA 94111"
account_idstring(uuid)required

ID of the account that owns the property

Example: "4b88ff32-8ba0-4bbf-8e60-c789909ac176"
created_atstring(date-time)required

Timestamp when the property was created

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

Timestamp when the property was last updated

Example: "2023-01-16T14:30:00Z"
]
Response
application/json
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "community_name": "Sunset Towers",
    "building_count": 3,
    "unit_count": 75,
    "description": "Luxury apartment community with amenities",
    "structure_type": "Mid Rise",
    "year_built": 2008,
    "photos": [ … ],
    "external_ids": { … },
    "text_address": "123 Main St, San Francisco, CA 94111",
    "account_id": "4b88ff32-8ba0-4bbf-8e60-c789909ac176",
    "created_at": "2023-01-15T12:00:00Z",
    "updated_at": "2023-01-16T14:30:00Z"
  }
]

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