Connect other apps or build on top of Uplisting

Use your API key to connect to other third-party apps like PriceLabs and Keydata, or build your own solutions using all your data on Uplisting. Use your Webhook key to connect to other third-party apps like Keydata and Wishbox, or build your own solutions using all your data on Uplisting.

Where to find your API key

Your API key can be generated on the Connect > API page, here.

Where to find your Webhook key

Your API key can be generated on the Connect > Webhook page, here.

Building on top of Uplisting's API & webhooks

Uplisting's API is invite-only. Reach out to us on [email protected] if you'd like access to our documentation and Partner Page information.

🚧

Webhook Responsiveness & Disablement

Please note: If an endpoint fails to respond to 5 different events consecutively, our system will mark it as disabled. From that point forward, no further events will be posted to this endpoint until further notice.

Please ensure your endpoint is reliable and responds within the expected timeframe (5 seconds) to avoid disruption.

Uplisting Partner API FAQ for Clients

Do you have example requests or a Postman collection?

Yes: Uplisting API.

How should the Authorization header be formed?

Use HTTP Basic auth with the Base64 encoded API key: {{Authorization: Basic <base64(api_key)>}}

Why am I getting 401 Unauthorized?

Most commonly, the API key is not Base64 encoded correctly, or you are using the wrong environment key.

Is there a staging environment?

Yes. Staging and production use the same endpoints and paths, but a different base domain. Accounts and API keys are environment-specific. Create a staging account here.

What are the API rate limits?

All calls to the Uplisting API are subject to rate limiting. If a partner exceeds the rate limits, a 429 Too Many Requests response is returned. We recommend to stagger requests througout a longer time frame to avoid hitting 429s.

We allow up to:

• 5 requests per second per IP address
• no more than 100 requests per minute per IP address
• no more than 15 requests per min per property

How do I register webhooks?

Register webhooks by following the steps outlined here.

Our webhook stopped. What should we check first?

Confirm your endpoint returns a 2xx response within 5 seconds. Repeated failures or timeouts can disable delivery.

When do I need a Client ID?

You need a Client ID if you intend to use V2 endpoints, which are outlined here. Email [email protected] with your integration use case.

What are custom booking attributes?

Custom booking attributes are extra fields stored on a booking, for example, a lock code or internal reference, that can be used in features like automated message tags. More information here.

How do we enable custom booking attributes for our integration?

Custom booking attributes require V2 access and a Client ID. Reach out to [email protected] to get access to those. You will also need to confirm an attribute prefix, which is the namespace used to group the attributes your integration creates.

Quote endpoints

The API does not currently provide a dedicated “quote” endpoint or a full price breakdown for a stay. Use the API to sync availability plus nightly prices and restrictions, then calculate the total on your side. Adjustments like extra charges or discounts must be handled in your own pricing logic before finalizing the reservation.

Do you support guest messaging or inbox APIs?

The public API does not include guest messaging or inbox endpoints.