# Rently Documentation
> Documentation for Rently
Append .md to any documentation page URL to get its markdown version.
## API Reference
- [Stage 1: property data sync into Rently](https://apidocs.rently.com/reference/stage-1-property-data-sync-into-rently.md)
- [Stage 2: Rently SGT Integration - Prospect Registration in rently with Signed JWT](https://apidocs.rently.com/reference/stage-2-rently-sgt-integration-sso-with-jwt.md)
- [Lead Activities Report](https://apidocs.rently.com/reference/lead-activities-report.md)
- [Leads Report](https://apidocs.rently.com/reference/leads-report.md)
- [Properties Report](https://apidocs.rently.com/reference/properties-report.md)
- [Post Viewing Survey Report](https://apidocs.rently.com/reference/post-viewing-survey-report.md)
- [Lockboxes Report](https://apidocs.rently.com/reference/lockboxes-report.md)
- [ILS Inquiries Report](https://apidocs.rently.com/reference/ils-inquiries-report.md)
- [Phone Inquiries](https://apidocs.rently.com/reference/phone-inquiries.md)
- [Vendor Access](https://apidocs.rently.com/reference/vendor-access.md)
- [Tenant Access](https://apidocs.rently.com/reference/tenant-access.md)
- [Properties Summary View](https://apidocs.rently.com/reference/properties-summary-view.md)
- [Active Agents List](https://apidocs.rently.com/reference/active-agents-list.md)
- [Agent Login Audit](https://apidocs.rently.com/reference/agent-login-audit.md)
- [Lockbox Activity Export](https://apidocs.rently.com/reference/lockbox-activity-export.md)
- [Lead Actvitiy Source](https://apidocs.rently.com/reference/lead-actvitiy-source.md)
- [Stage 4: Rently Activities Notification via Webhook](https://apidocs.rently.com/reference/stage-3-rently-activities-notification-via-webhook.md)
- [Lock Unlock Code](https://apidocs.rently.com/reference/unlock-code.md)
- [Lock Unlock Code v2](https://apidocs.rently.com/reference/lock-unlock-code-v2.md)
- [Hub Unlock Code](https://apidocs.rently.com/reference/hub-unlock-code.md)
- [Invitation Creation](https://apidocs.rently.com/reference/invitation-creation.md)
- [Invitation Deletion](https://apidocs.rently.com/reference/invitation-deletion.md)
- [Visitor Access Code Creation](https://apidocs.rently.com/reference/rently-visitor-access-codes-v1.md): This API provides visitor access code valid for a duration within next seven days and supports automated delivery via SMS or email. This api is an automation of Visitor Access Code function of Rently Manager portal
- [Agents](https://apidocs.rently.com/reference/agents.md)
- [Login](https://apidocs.rently.com/reference/login.md): API to get agent access token # Parameter | Field | Type | Description | |----------|-------------|------| | grant_type | String | "password" | | password | String | Account unique password | | username | String | Account unique username |
- [Accounts](https://apidocs.rently.com/reference/accounts.md): Get list of impersonate accounts the user have access.
- [Properties](https://apidocs.rently.com/reference/properties.md)
- [List of Properties](https://apidocs.rently.com/reference/listofproperties.md): # Parameter | Field | Type | Description | | --- | --- | --- | | page `optional` | Number | Page no. default 1 | | per_page `optional` | Number | Page size, default 20 max 100 | | home_name `optional` | String | Property name | | address `optional` | String | Property address | | state `optional` | String | Property state | | city `optional` | String | city state | | account `optional` | String | Impersonate account id (or) all | | unit_code\[\] `optional` | String | Property Unit Code. To search by multiple unit codes, you have to pass this parameter redundantly with different values. Example: To search by unit code values as 'test1' and 'test2' you need to pass parameters as: unit_code\[\]=test1&unit_code\[\]=test2 | | api_code\[\] `optional` | String | Property Api Code. To search by multiple api codes, you have to pass this parameter redundantly with different values. Example: To search by api code values as 'test1' and 'test2' you need to pass parameters as: api_code\[\]=test1&api_code\[\]=test2 | | pms_datapull_id\[\] `optional` | String | Property PMS Datapull ID. To search by multiple pms datapull ids, you have to pass this parameter redundantly with different values. Example: To search by pms datapull ids as 'test1' and 'test2' you need to pass parameters as: pms_datapull_id\[\]=test1&pms_datapull_id\[\]=test2 |
- [Create Property](https://apidocs.rently.com/reference/createproperty.md): Agents having user roles Admin, Manager, Community Manager, Regional Manager, Leasing Specialist, Hub Installer are allowed to access this API.
- [Property details](https://apidocs.rently.com/reference/propertydetails.md): # Parameter | Field | Type | Description | |----------|-------------|------| | id | Integer | property unique ID. |
- [Update Property](https://apidocs.rently.com/reference/updateproperty.md): Agents having user roles Admin, Manager, Community Manager, Regional Manager, Leasing Specialist, Hub Installer are allowed to access this API. # Parameter | Field | Type | Description | |----------|-------------|------| | id | Integer | Property ID |
- [Change Company](https://apidocs.rently.com/reference/changecompany.md): # Parameter | Field | Type | Description | |----------|-------------|------| | id | Integer | property unique ID. |
- [Destroy Property](https://apidocs.rently.com/reference/destroyproperty.md)
- [Property Devices](https://apidocs.rently.com/reference/propertydevices.md): # Parameter | Field | Type | Description | |----------|-------------|------| | id | Integer | Property ID |
- [Move-out all invitations](https://apidocs.rently.com/reference/move-outallinvitations.md)
- [Hubs](https://apidocs.rently.com/reference/hubs.md)
- [Hub List](https://apidocs.rently.com/reference/hublist.md): # Parameter | Field | Type | Description | |----------|-------------|------| | page `optional` | Number | Page no. default 1 | | per_page `optional` | Number | Page size, default 20 max 100 | | home_name `optional` | String | Hub name | | serial_no `optional` | Number | Hubs serial no. | |view `optional` | String | 'all/assigned/unassigned', default assigned. | | account `optional` | String | Impersonate account id (or) all | | assigned_date `optional` | Date | Assigned date("yyyy-mm-dd"). |
- [Hub Details](https://apidocs.rently.com/reference/hubdetails.md): # Parameter | Field | Type | Description | |----------|-------------|------| | id | Uuid | Hub unique ID. |
- [Update Hub Details](https://apidocs.rently.com/reference/updatehubdetails.md): Update hub or send commands to hub. # Parameter | Field | Type | Description | |----------|-------------|------| | id | Uuid | Hub unique ID. |
- [Assign/Unassign Property](https://apidocs.rently.com/reference/assignunassignproperty.md)
- [List of Devices](https://apidocs.rently.com/reference/listofdevices.md): # Parameter | Field | Type | Description | |----------|-------------|------| | id | Uuid | Hub unique ID. |
- [Ssh key for a hub](https://apidocs.rently.com/reference/sshkeyforahub.md): # Parameter | Field | Type | Description | |----------|-------------|------| | serial_no | Number | Hub serial_no. |
- [Devices](https://apidocs.rently.com/reference/devices.md)
- [Device Details](https://apidocs.rently.com/reference/devicedetails.md): # Parameter | Field | Type | Description | |----------|-------------|------| | id | Uuid | Device unique ID. |
- [Update Device Details](https://apidocs.rently.com/reference/updatedevicedetails.md): Update device's name or send commands to device. # Parameter | Field | Type | Description | |----------|-------------|------| | id | Uuid | Device unique ID. |
- [Assign/Unassign Property](https://apidocs.rently.com/reference/patchassignunassignproperty.md): Allowed for Oaks lock and Individual z-wave lock devices only.
- [Reservations](https://apidocs.rently.com/reference/reservations.md)
- [Create Reservation](https://apidocs.rently.com/reference/createreservation.md): # Parameter | Field | Type | Description | | --- | --- | --- | | name | String | Set Guest name | | email | String | Set Guest email | | phone | String | Set Guest phone | | from_time | DateTime | Set reservation from time mm/dd/yyyy hh:mm AM/PM | | to_time | DateTime | Set reservation to time mm/dd/yyyy hh:mm AM/PM | | security_code | Integer | Passcode attached with Reservation. | | reservation_id | String | Set reservation reservation_id | | unit_code/api_code/hub_ids/property_ids | Uuid/Uuid/Integer | Atleast one should be present. Either unit_code or api_code or hub_ids or property_ids need to be sent as \[unit_code1, unit_code2\] or \[api_code1, api_code2\] or \[hub_id1, hub_id2\] or \[property_id1, property_id2\] |
- [Reservations list](https://apidocs.rently.com/reference/reservationslist.md): # Parameter | Field | Type | Description | |----------|-------------|------| | page_no `optional` | Integer | Default value is 1 | | per_page `optional` | Integer | Default value is 20 | | tab `optional` | String | Default value is 'current'. Allowed values are 'current', 'upcoming', 'cancelled', 'expired' | | search_reservation `optional` | String | Searches for Reservation ID, Reservation Name, Property's Name | | paging `optional` | Boolean | If this key is passed, response will contain keys like page, per_page, total_records, reservations |
- [Resevations Details](https://apidocs.rently.com/reference/resevationsdetails.md): # Parameter | Field | Type | Description | |----------|-------------|------| | id | Uuid | Reservation unique ID |
- [Reservations update](https://apidocs.rently.com/reference/reservationsupdate.md): # Parameter | Field | Type | Description | |----------|-------------|------| | id | Uuid | Reservation unique id | | name | String | Update Guest name | | email | String | Update Guest email | | phone | String | Update Guest phone | | from_time | DateTime | Set reservation from time mm/dd/yyyy hh:mm AM/PM | | to_time | DateTime | Set reservation to time mm/dd/yyyy hh:mm AM/PM | | unit_code/api_code/hub_ids/property_ids | Uuid/Uuid/Integer | Atleast one should be present. Either unit_code or api_code or hub_ids or property_ids need to be sent as [unit_code1, unit_code2] or [api_code1, api_code2] or [hub_id1, hub_id2] or [property_id1, property_id2] |
- [Reservations delete](https://apidocs.rently.com/reference/reservationsdelete.md): # Parameter | Field | Type | Description | |----------|-------------|------| | id | Uuid | Reservation unique ID |
- [Codes](https://apidocs.rently.com/reference/codes.md)
- [Create lock code](https://apidocs.rently.com/reference/createlockcode.md): # Parameter | Field | Type | Description | |----------|-------------|------| | hub_id/device_id/property_id | Uuid/Uuid/Integer | Either hub's or device's or property's unique ID should be passed | | validity_type | String | Code Validity Type. Allowed values are 'By Day of Week', 'Specific Period','Never Expires', 'Daily Repeating'. | |device_ids `optional` | Array | Device's unique ID can be sent as for multiple devices as [Uuid1, Uuid2]. | Note:- Either hub_id or device_id or property_id or device_ids should be passed. In case of validity_type as 'Specific Period' need to pass 'from_date' and 'to_date' in form of YYYY-MM-DD HH-MM In case of validity_type as 'By Day of Week' need to pass schedule_details_info parameter with values as [{ 'd': Day of week index(Sunday=0, Monday=1,..,Saturday=6), 'f': From Time(in HH:MM), 't': To Time(in HH:MM) }] In case of valiity_type 'Daily Repeating', need to pass schedule_details_info parameter with value as [{ 'wd': [Day of week indexes in string(Sunday=0, Monday=1,..,Saturday=6)], 'f': From Time(in HH:MM), 't': To Time(in HH:MM) }] In case of creating Vacancy Code, need to pass code_type parameter with value 'Vacancy Code'.
- [Lock Code List](https://apidocs.rently.com/reference/lockcodelist.md): # Parameter | Field | Type | Description | |----------|-------------|------| | hub_id/device_id/property_id | Uuid//Uuid/Integer | Either hub's or device's or property's unique ID should be passed |
- [Update lock code](https://apidocs.rently.com/reference/updatelockcode.md): **Deprecation Notice:** This endpoint is deprecated and will be removed in future. Please use the V2 endpoint: **/v2/lock_codes/{id}**. # Parameter | Field | Type | Description | |----------|-------------|------| | id | Uuid | Lock Code ID |
- [Lock code details](https://apidocs.rently.com/reference/lockcodedetails.md): # Parameter | Field | Type | Description | |----------|-------------|------| | id | Uuid | LockCode's unique ID. | | hub_id `optional` | Uuid | Hub unique ID. |
- [Lock code delete](https://apidocs.rently.com/reference/lockcodedelete.md): # Parameter | Field | Type | Description | |----------|-------------|------| | id | Uuid | Lock Code ID |
- [Lock code status](https://apidocs.rently.com/reference/lockcodestatus.md): # Parameter | Field | Type | Description | |----------|-------------|------| | lock_code_id `optional` | Uuid | LockCode's unique ID. | | device_id `optional` | Uuid | Device's unique ID. | | hub_id `optional` | Uuid | Hub's unique ID. | | property_id `optional` | Integer | Property's unique ID. |
- [Retry Lock Code](https://apidocs.rently.com/reference/retrylockcode.md): # Parameter | Field | Type | Description | |----------|-------------|------| | id | Uuid | Lock Code's ID. | | device_id | Uuid | Device Unique ID |
- [Generate random security code](https://apidocs.rently.com/reference/generaterandomsecuritycode.md): # Parameter | Field | Type | Description | |----------|-------------|------| | hub_id `optional` | Uuid | Hub's unique ID |
- [Update lock code (V2)](https://apidocs.rently.com/reference/updatelockcodev2.md): ## 📢 Changes from V1 The V2 API (**/v2/lock_codes/{id}**) introduces the following changes to the functionality compared to V1 (**/lock_codes/{id}**): * **For Unit Door Code:** There is no changes. * **For Community Door Code:** The **security_code** passed in the requestBody will be set for the doors, when single code for common area is enabled in the settings. # Parameter | Field | Type | Description | |----------|-------------|------| | id | Uuid | Lock Code ID | ---
- [Schedules](https://apidocs.rently.com/reference/schedules.md)
- [Create Schedule](https://apidocs.rently.com/reference/createschedule.md): # Parameter | Field | Type | Description | |----------|-------------|------| | schedule_name | String | Name of schedule | | device_type | String | Type of device | | schedule_details_info | Json | Details of schedule | # Success 200 | Field | Type | Description | |----------|-------------|------| | success | Boolean | True or False | | message | String | Success or Failed to create Schedule or Schedule name can't be blank or At least one schedule must be present | | id | Uuid | Schedule Unique Id |
- [Device Schedule list](https://apidocs.rently.com/reference/deviceschedulelist.md): # Parameter | Field | Type | Description | |----------|-------------|------| | device_id | Uuid | Device unique ID. |
- [All Schedules [Outdated]](https://apidocs.rently.com/reference/allschedulesoutdated.md): # Parameter | Field | Type | Description | |----------|-------------|------| | device_type `optional` | String | Device type | | page `optional` | Number | Page no. default 1 | | per_page `optional` | Number | Page size, dafault 20 max 100 |
- [Schedule details](https://apidocs.rently.com/reference/scheduledetails.md): # Parameter | Field | Type | Description | |----------|-------------|------| | id | Uuid | Schedule unique ID. | Note: "m" => Mode "d" => Day of week(Sunday=0, Monday=1......,Saturday=6) "f" => From time hh:mm "v" => Setpoint value
- [Schedule destroy](https://apidocs.rently.com/reference/scheduledestroy.md): # Parameter | Field | Type | Description | |----------|-------------|------| | id | Uuid | Schedule unique ID. |
- [Update Schedule](https://apidocs.rently.com/reference/updateschedule.md): # Parameter | Field | Type | Description | |----------|-------------|------| | id | Uuid | schedule unique id | | schedule_name | String | Name of schedule | | device_type | String | Type of device | | schedule_details_info | Json | Details of schedule |
- [Activate Schedule for Device](https://apidocs.rently.com/reference/activateschedulefordevice.md): # Parameter | Field | Type | Description | |----------|-------------|------| | device_id | Uuid | Device unique ID. | | active | Boolean | true/false |
- [Webhooks](https://apidocs.rently.com/reference/webhooks.md)
- [AppLevelWebhook](https://apidocs.rently.com/reference/applevelwebhook.md): Check the example for different webhooks and sample data.
- [Activity](https://apidocs.rently.com/reference/activity.md)
- [Get Hub's activity](https://apidocs.rently.com/reference/gethubsactivity.md): # Parameter | Field | Type | Description | |----------|-------------|------| | id | Uuid | Hub Unique ID | | next_page `optional` | String | Next page value |
- [Get Hub's desired activities](https://apidocs.rently.com/reference/get_hubs-id-desired-activities.md): | Field | Type | Description | | --- | --- | --- | | from_date
`optional when to_date is also not provided` | String | To filter the hub activities logs for the events from the given date string.
DEFAULT VALUE: current_date - 1week
FORMAT : "`MM/DD/YYYY`" | | to_date
`optional when from_date is also not provided` | String | To filter the hub activities logs for the events till the given date string.
DEFAULT VALUE: Current date
FORMAT : "`MM/DD/YYYY`" | | events | String | To filter the hub activities logs for the passed events within the given date range.
FORMAT: String with comma separated values.
EXAMPLE: `add_device,remove_device`
POSSIBLE VALUES: `add_device, remove_device` | The API returns status code 422 - Unprocessable Entity for the following scenarios: - When the events param is not available - When events param is passed with empty value - When events has values other than permitted event_types - When from_date is available in the param but not to_date - When to_date is available in the param but not from_date - When either of date field doesn't match format `MM/DD/YYYY` - When the from_date is after the to_date - When the date range is more than a week The API returns status code 403 - Forbidden for the following scenarios: - When hub is not found - When resident access the API - When the agent doesn't have access for the hub logs requested - When the agent is from different company - When the agent access hub's previous logs (when both `from_date` and `to_date` are before hub's `company_change_date`) NOTE: - When the `from_date` is before the hub's company change date, but the agent has access to the logs within the given date range, then the API returns the response hash with requested events from the date to which the agent has access. - Example 1: - hub's company_change_date -> Jan 10 2023 - from_date -> '01/07/2023' - to_date -> '01/12/2023' - In this scenario, the API returns data from Jan 10 till Jan 12. - Example 2: - hub's company_change_date -> Jan 10 2023 - from_date -> '01/01/2023' - to_date -> '01/07/2023' - In this scenario, the API returns data 403 error. - Example 3: - hub's company_change_date -> Jan 10 2023 - from_date -> '01/10/2023' - to_date -> '01/10/2023' - In this scenario, the API returns Jan 10 activities.
- [Get Device's activity](https://apidocs.rently.com/reference/getdevicesactivity.md): # Parameter | Field | Type | Description | |----------|-------------|------| | id | Uuid | Device Unique ID | | next_page `optional` | String | Next page value |
- [MQTT](https://apidocs.rently.com/reference/mqtt.md)
- [Get MQTT Canonical Url](https://apidocs.rently.com/reference/getmqttcanonicalurl.md): There are 2 ways to connect via MQTT. Both use the cognito credentials for the hub. mqtt_canonical_url is used to connect from browser in the manager portal from javascript. get_cognito_credentials is used by the ios and android libraries. There is sample code mentioned for both methods. # Parameter | Field | Type | Description | |----------|-------------|------| | id | Uuid | Hub Unique ID |
- [Get Cognito credentials](https://apidocs.rently.com/reference/getcognitocredentials.md): There are 2 ways to connect via MQTT. Both use the cognito credentials for the hub. mqtt_canonical_url is used to connect from browser in the manager portal from javascript. get_cognito_credentials is used by the ios and android libraries. There is sample code mentioned for both methods # Parameter | Field | Type | Description | |----------|-------------|------| | id | Uuid | Hub Unique ID |
- [MQTT Responses](https://apidocs.rently.com/reference/mqttresponses.md): This is a sample data
- [Invitations](https://apidocs.rently.com/reference/invitations.md)
- [Invitation Details](https://apidocs.rently.com/reference/invitationdetails.md)
- [Move Out](https://apidocs.rently.com/reference/moveout.md): Not permitted to Agents with role as Reservation, Reservation RW, Monitor Only, V3Installer, Hub Installer.
- [Update Invitation](https://apidocs.rently.com/reference/updateinvitation.md): # Parameter | Field | Type | Description | |----------|-------------|------| | name `optional` | Invitation Name | Invitation name. | | from_date `optional` | Start date of invitation | Format (YYYY-MM-DD) | | to_date `optional` | End date of invitation | Format (YYYY-MM-DD) | | phone `optional` | Invitation phone number | | | security_code `optional` | Passcode attached with invitation | | | fob_id `optional` | Fob number attached with invitation | Should be 10 digits long | | invitation_status `optional` | Status of invitation# Parameter | Allowed values Accepted/Revoked |
- [Create Invitation](https://apidocs.rently.com/reference/createinvitation.md)
- [List of Invitations](https://apidocs.rently.com/reference/listofinvitations.md): # Parameter | Field | Type | Description | | --- | --- | --- | | page `optional` | Integer | Default value is 1 | | per_page `optional` | Integer | Default value is 20. Maximum 100 | | property_id `optional` | Integer | Smart Home asset unique ID | | status `optional` | String | Optional, Default value for search is 'all'. Allowed values are 'all', 'invited', 'accepted', 'move out initiated', 'moved out'. To search invitations against properties having hubs, pass search values like 'all' or 'invited' or 'accepted'. To search invitations against properties with oaks locks, pass search values like 'all' or 'invited' or 'accepted' or 'move out initiated' or 'moved out'. If include_deleted is passed as true, then 'denied', 'revoked' and 'removed' are allowed to search. | | name `optional` | String | Invitation Name | | email `optional` | String | Invitation Email | | phone `optional` | String | Invitation Phone Number | | account_id `optional` | String | Impersonate Account ID (or) all | | include_deleted `optional` | Boolean | Default value is false. Allowed values are true or false. Pass true to include deleted records. | | updated_after `optional` | String | Get list of invitation records which are updated on and after passed value. Allowed format YYYY-MM-DD. |
- [Schedule Availability](https://apidocs.rently.com/reference/schedule-availability.md)
- [List of active prebookable communities](https://apidocs.rently.com/reference/get_active_communities.md): Returns a paginated list of active communities that are configured for prebooking and have at least one Self-Guided Tour unit present. Each page returns up to 100 communities by default.
- [Pre Booking ILS Webhooks](https://apidocs.rently.com/reference/pre-booking-ils-webhooks.md): We now support webhooks for ILS partners using our prebooking APIs. To enable webhooks, the ILS partner must configure them in Active Admin. Once enabled, ILS partners receive webhooks with updated prebooking details when a prebooking is confirmed, rescheduled cancelled or when the tour is completed.This webhook triggers for both single-family and multifamily prebooking updates
- [OAuth token](https://apidocs.rently.com/reference/post_oauth-token.md): This API generates Bearer Token Parameters - client_id - client_secret - grant_type → client_credentials
- [Schedule a Prebooked visit for a Property](https://apidocs.rently.com/reference/post_api-v1-prebook-schedule-visit.md): It schedules a tour on the available calendar slot.
- [Get Property time availability](https://apidocs.rently.com/reference/get_api-v1-prebook-get-time-availability.md): It pulls available calendar dates & slots for the Property.
- [Get Scheduled Tour Status](https://apidocs.rently.com/reference/get_api-v1-prebook-scheduled-tour-status.md): Get the tour status of the prebooked tour. Eg: scheduled, completed, show, no_show, etc
- [Get Property Settings](https://apidocs.rently.com/reference/get_api-v1-prebook-settings-1.md): Returns company-specific configurations for a given property. It currently returns the parallel_self_tours_enabled and duration_in_minutes configuration. When parallel_self_tours_enabled is true, multiple prospects can book the same slot for a property. duration_in_minutes indicates self touring duration set under company.
- [Update Prebooking (Reschedule or Cancel)](https://apidocs.rently.com/reference/put_api-v1-prebook-id.md): Reschedule or cancel a prebooking using the tour_id. Send visit_date to reschedule or status=cancelled to cancel. Authentication: Client Credential Token (Bearer token). Note: Either visit_date or status must be provided in the request. Both cannot be omitted.
- [Pre Booking ILS Webhooks](https://apidocs.rently.com/reference/pre-booking-ils-webhooks-1.md): We now support webhooks for ILS partners using our prebooking APIs. To enable webhooks, the ILS partner must configure them in Active Admin. Once enabled, ILS partners receive webhooks with updated prebooking details when a prebooking is confirmed, rescheduled cancelled or when the tour is completed.This webhook triggers for both single-family and multifamily prebooking updates