Articles on: Public and Partner API

API Partner integration

Thanks for your interest in becoming an Uplisting integrated partner!


Integration process


Legacy API (V1/V2)


  1. Review our API docs here. The staging environment endpoints are the same as production. However, the domain is https://connect.staging-uplisting.io.
  2. Create a staging account here. To maintain access past 14 days, go to the billing page and enter the following credit card: 4242 4242 4242 4242. Expiry: 01/29. CVC: 111.
  3. Connect to an Airbnb account (this is easiest) or manually add test properties here. Note: Account Owner/Admin User’s account must be verified by tech support to manually add listings.
  4. Retrieve the test accounts API key (Connect>API Key) here.
  5. Ensure you have Base64 encoded your API Key and Verified it's correct per the GET Verify API Key endpoint:
  7. You will also need a client ID if you intend to use our V2 endpoints. Reach out to partner@uplisting.io to get this.


🚧 Note: Partner clients must have their custom_booking_attribute_prefix set before they can create custom booking attributes.Please contact our Partner team on partner@uplisting.io to have that configured


  1. You can find our Uplisting Partner API FAQ for Clients here



V3 API / OAuth

Our V3 API uses OAuth2 authentication and is the recommended route for new integrations and newer API functionality.


The latest API documentation, including OAuth setup and V3 endpoints, is available here: https://documenter.getpostman.com/view/6655410/2sBY4HSNpH


V3 supports OAuth scopes for properties, bookings, calendar data, reviews, custom booking attributes and guest messaging.


To set up a V3 OAuth client, email partner@uplisting.io with:

  • Your partner/company name
  • Technical contact email address
  • Required API scopes
  • Direct HTTPS redirect URI or URIs
  • Custom booking-attribute prefix.


Redirect URIs must be sent exactly as your application will use them, for example:

https://app.example.com/oauth/uplisting/callback


Please do not send Google/Gmail wrapper links, homepage URLs, or localhost URLs.
Once set up, we will provide your OAuth client_id and client_secret for the Authorisation Code + PKCE flow.



Existing integrations

Existing V1/V2 API endpoints and webhooks remain available using Basic API-key authentication. There is no immediate migration requirement.



Uplisting API Support


Reach out to us at partner@uplisting.io, where we are happy to help with any questions


Please note we're unable to take phone calls for API related queries and correspond only via email.


Before Going Live with a new integration

Please contact the Partner team on partner@uplisting.io to receive a copy of the Uplisting Partner API Integration agreement. This agreement is for non-Uplisting users/customers and includes a Revenue Share scheme, usage limitations and licensing for marketplace partners.


Once you have completed the integration and the agreement is signed and returned we will be able to provide co-marketing efforts, marketing integration section page inclusion and an affiliate link (if requested).


We can discuss alerting our members to your integration.


Integrating a Booking site or OTA?

We can discuss placement on our booking site tab if you are representing a booking site or OTA. For these queries, email partner@uplisting.io

Updated on: 06/07/2026

Was this article helpful?

Share your feedback

Cancel

Thank you!