> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pxaccounting.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect Uplisting

> Get your Uplisting API key and connect it to PX Accounting.

PX Accounting connects to Uplisting with an API key from your Uplisting account.

<Frame caption="Selecting Uplisting on the PMS Connection card">
  <img src="https://mintcdn.com/px-abfbc0ec/FnkoR7egJ-TCQwHz/images/screenshots/pms-picker-uplisting.png?fit=max&auto=format&n=FnkoR7egJ-TCQwHz&q=85&s=06825dabbd50dffe384d4189da416bd2" alt="Uplisting in the PMS picker" width="1440" height="900" data-path="images/screenshots/pms-picker-uplisting.png" />
</Frame>

## Before you start

You will need:

* An Uplisting account.
* Owner-level login.

## Step 1 - generate or copy your API key

1. Sign in to Uplisting.
2. Go to [app.uplisting.io/connect/api](https://app.uplisting.io/connect/api).
   * First-time visitors: click to generate a key.
   * Returning visitors: copy the existing key.

For background, see Uplisting's docs: [API & Webhooks](https://support.uplisting.io/docs/api).

<Warning>
  Uplisting issues a single API key per account, with full scope. **Rotating it breaks every existing integration simultaneously**, including any other tools you have connected. Coordinate before rotating.
</Warning>

## Step 2 - paste the key into PX

1. In PX, open **Settings**.
2. In the **PMS Connection** card, pick **Uplisting**.
3. Paste the **API key**.
4. Click **Save credentials**.

PX validates the key and the **Integration Status** panel shows three lights: **Admin**, **OAuth**, and **Webhook**.

## What PX reads from Uplisting

PX has **read-only** access. Nothing is written back.

**Properties** - id, name, address, bedrooms / bathrooms / max guests, property type, currency, active flag, thumbnail.
*Synced on connect, on listing webhooks, and on Properties -> Sync from Uplisting.*

**Owners** - id, first / last name, email, phone, properties owned.
*Synced with the parent property.*

**Reservations** - id, listing, status, check-in / check-out, booking date, guest details, guest count breakdown, channel and confirmation code, currency, totals.
*Synced on demand, on booking webhooks, and during audits.*

**Per-charge financial data** - line amount and type (accommodation / cleaning / fee / tax / discount), taxable flag, per-night accommodation breakdown, per-reservation totals, payments.
*Synced with the parent reservation; payments also via payment webhooks.*

**Tax catalog** - rates, names, applicability per listing.
*Synced on Tax Configuration -> Refresh from PMS.*

**Webhook events** - booking created / updated / canceled, listing created / updated, payment received / refunded.

## Removing the connection

Open **Settings**, scroll to the **PMS Connection** card, and click **Delete**. The key is wiped from PX and webhooks are unregistered.

## Troubleshooting

**Admin status is red.**
The API key is wrong or was rotated in Uplisting. Get the latest value and update PX.

**Other integrations broke after rotating the key.**
Expected. Uplisting uses a single shared key. Update every integration that uses it, including PX.