Skip to main content
Uplisting logo
  • Category: scheduling & booking
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: UPLISTING
  • Version: 20261101_00

Tools

Slug: UPLISTING_CREATE_WEBHOOKRegister a public callback URL for one booking or property event and return the new webhook ID.

Input Parameters

string ("booking_created" | "booking_updated" | "booking_removed" | "property_created" | "property_updated" | "property_removed")
required
Uplisting event that should be delivered to the callback URL.
string
required
Public HTTPS callback URL that can respond within 5 seconds and safely handle duplicate or out-of-order events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UPLISTING_DELETE_WEBHOOKPermanently remove one Uplisting webhook subscription by its ID. This is destructive and stops future event deliveries to that subscription.

Input Parameters

string
required
Webhook ID returned by Create Webhook or List Webhooks. The selected subscription will be permanently removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UPLISTING_GET_CALENDARReturn up to 12 months of daily availability, rates, and stay restrictions for one property.

Input Parameters

string
Last calendar date in YYYY-MM-DD format; must be after from_date and no more than 12 months later.
string
First calendar date in YYYY-MM-DD format. Without dates, Uplisting returns one year from today.
string
required
Property ID returned by List Properties.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UPLISTING_GET_CURRENT_ACCOUNTReturn the name and stable UID of the Uplisting account connected by the current API key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UPLISTING_GET_PROPERTYReturn one Uplisting property by ID with the related resources supplied by the API.

Input Parameters

string
required
Property ID returned by List Properties.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UPLISTING_LIST_BOOKINGSReturn one explicitly selected 0-based page of bookings for a property and optional date range, with total and total-page metadata.

Input Parameters

integer
Zero-based page index to return. Increment this value while page is less than total_pages - 1.
string
Latest booking date in YYYY-MM-DD format; must be after from_date when both are set.
integer
Bookings per page (1-50).
string
Earliest booking date in YYYY-MM-DD format. Without dates, Uplisting returns one year from today.
string
required
Property ID returned by List Properties.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UPLISTING_LIST_PROPERTIESReturn all properties in the connected Uplisting account, including the related resources supplied by the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UPLISTING_LIST_WEBHOOKSReturn the webhook subscriptions registered for the connected Uplisting account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UPLISTING_SEARCH_AVAILABILITYFind Uplisting properties available for optional stay dates, guest count, city, and nightly price bounds.

Input Parameters

string
City in which to search for available properties.
string
Arrival date in YYYY-MM-DD format.
string
Departure date in YYYY-MM-DD format. When both dates are set, this must be after check_in.
number
Maximum nightly price to include. This must not be below min_price when both are set.
number
Minimum nightly price to include.
integer
Number of guests the property must accommodate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UPLISTING_UPDATE_CALENDARAsynchronously update availability, rates, or stay restrictions for current or future dates on one property. HTTP 202 means the update was accepted, not completed; propagation may take several minutes, so check the calendar later to verify the resulting state.

Input Parameters

array
required
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.
string
required
Property ID whose live calendar will be changed.
string
Public HTTPS URL to receive Uplisting’s asynchronous success or failure callback. Omit when no controlled callback endpoint is available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not