RentEngine Public API (1.1.1)

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

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:

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:

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:

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.