# Rently Documentation > Documentation for Rently ## API Reference: Rently Touring integration & APIs - [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… ## API Reference: Smart Home Open APIs - [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… - [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… - [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… - [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… - [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 |… - [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… - [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… - [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… - [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… - [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 |… - [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… - [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.… - [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 | |… - [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 | |… - [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,… - [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 |… - [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… - [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… - [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… - [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… - [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… ## API Reference: Multifamily Availability API - [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… ## API Reference: Singlefamily Availability APIs - [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,… - [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… - [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…