--- canonical_url: "https://docs.composio.dev/toolkits/uplisting" markdown_url: "https://docs.composio.dev/toolkits/uplisting.md" product: "platform" version: null last_updated: null --- # Uplisting Uplisting is a vacation rental property management platform for managing properties, availability, bookings, calendars, and webhooks. - **Category:** scheduling & booking - **Auth:** API_KEY - **Composio-managed OAuth available?** N/A - **Tools:** 10 - **Triggers:** 0 - **Slug:** `UPLISTING` - **Version:** 00000000_00 ## Tools ### Create Webhook **Slug:** `UPLISTING_CREATE_WEBHOOK` Register a public callback URL for one booking or property event and return the new webhook ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `event` | string ("booking_created" | "booking_updated" | "booking_removed" | "property_created" | "property_updated" | "property_removed") | Yes | Uplisting event that should be delivered to the callback URL. | | `target_url` | string | Yes | Public HTTPS callback URL that can respond within 5 seconds and safely handle duplicate or out-of-order events. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Webhook **Slug:** `UPLISTING_DELETE_WEBHOOK` Permanently remove one Uplisting webhook subscription by its ID. This is destructive and stops future event deliveries to that subscription. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `webhook_id` | string | Yes | Webhook ID returned by Create Webhook or List Webhooks. The selected subscription will be permanently removed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Calendar **Slug:** `UPLISTING_GET_CALENDAR` Return up to 12 months of daily availability, rates, and stay restrictions for one property. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `to_date` | string | No | Last calendar date in YYYY-MM-DD format; must be after from_date and no more than 12 months later. | | `from_date` | string | No | First calendar date in YYYY-MM-DD format. Without dates, Uplisting returns one year from today. | | `property_id` | string | Yes | Property ID returned by List Properties. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Current Account **Slug:** `UPLISTING_GET_CURRENT_ACCOUNT` Return the name and stable UID of the Uplisting account connected by the current API key. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Property **Slug:** `UPLISTING_GET_PROPERTY` Return one Uplisting property by ID with the related resources supplied by the API. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `property_id` | string | Yes | Property ID returned by List Properties. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Bookings **Slug:** `UPLISTING_LIST_BOOKINGS` Return one explicitly selected 0-based page of bookings for a property and optional date range, with total and total-page metadata. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Zero-based page index to return. Increment this value while page is less than total_pages - 1. | | `to_date` | string | No | Latest booking date in YYYY-MM-DD format; must be after from_date when both are set. | | `per_page` | integer | No | Bookings per page (1-50). | | `from_date` | string | No | Earliest booking date in YYYY-MM-DD format. Without dates, Uplisting returns one year from today. | | `property_id` | string | Yes | Property ID returned by List Properties. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Properties **Slug:** `UPLISTING_LIST_PROPERTIES` Return all properties in the connected Uplisting account, including the related resources supplied by the API. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Webhooks **Slug:** `UPLISTING_LIST_WEBHOOKS` Return the webhook subscriptions registered for the connected Uplisting account. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Availability **Slug:** `UPLISTING_SEARCH_AVAILABILITY` Find Uplisting properties available for optional stay dates, guest count, city, and nightly price bounds. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `city` | string | No | City in which to search for available properties. | | `check_in` | string | No | Arrival date in YYYY-MM-DD format. | | `check_out` | string | No | Departure date in YYYY-MM-DD format. When both dates are set, this must be after check_in. | | `max_price` | number | No | Maximum nightly price to include. This must not be below min_price when both are set. | | `min_price` | number | No | Minimum nightly price to include. | | `number_of_guests` | integer | No | Number of guests the property must accommodate. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Calendar **Slug:** `UPLISTING_UPDATE_CALENDAR` Asynchronously change availability, rates, or stay restrictions for dated days or date ranges on one property. HTTP 202 only means the update was accepted; it may take several minutes to propagate. Use Get Calendar later to verify the resulting state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `days` | array | Yes | One or more dated-day or date-range updates. Each item must use either date or both from_date and to_date, never both forms. | | `property_id` | string | Yes | Property ID whose live calendar will be changed. | | `notification_url` | string | No | Public HTTPS URL to receive Uplisting's asynchronous success or failure callback. Omit when no controlled callback endpoint is available. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |