Skip to main content
Stays is a property management system (PMS) for short-term rentals and vacation properties. It helps hosts and property managers handle reservations, guest communication, pricing, channel distribution, and operational workflows from a single platform.

​
Configuring Stays as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Stays option from the list of connectors. Click Next and you’ll be prompted to add your access.

​
1. Add account access

You’ll need to provide your Stays API credentials. These can be obtained from your Stays account manager or through the Stays developer portal. The following configurations are available:
  • API URL: The base URL for the Stays API (e.g. https://api.stays.net/external/v1).
  • Username: The username used to authenticate against the Stays API.
  • Password: The password used to authenticate against the Stays API.

​
Advanced settings

  • Start Date: Earliest date from which date-based streams (reservations, reviews) are extracted. Defaults to today if not set.
  • End Date: Latest date until which date-based streams (reservations, reviews) are extracted. Defaults to today if not set.
  • Lookback Window: Number of days to look back from the last replication date to re-fetch updated records. Applies to all date-based streams. (Default: 365)
  • Extract Reservation Details: Whether to extract the Reservation Details stream, which makes one extra API call per reservation to fetch additional detail (guest list, fee/discount breakdown, operator/agent, promo code id). Disabled by default because it significantly slows down extraction.
Once you’re done, click Next.

​
2. Select streams

Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.
Tip: The stream can be found more easily by typing its name.
Select the streams and click Next.

​
3. Configure data streams

Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.
  • Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
  • Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
  • Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
  • Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
    • Incremental: every time the extraction happens, we’ll get only the new data - which is good if, for example, you want to keep every record ever fetched.
    • Full table: every time the extraction happens, we’ll get the current state of the data - which is good if, for example, you don’t want to have deleted data in your catalog.
Once you are done configuring, click Next.

​
4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can define some additional settings:
  • Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
  • Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.
Once you are ready, click Next to finalize the setup.

​
5. Check your new source

You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.
For you to be able to see it on your Catalog, you need at least one successful source run.

​
Streams and Fields

Below you’ll find all available data streams from Stays and their corresponding fields:
Stream containing property listings data from Stays.
Stream containing reservation data from Stays. Uses creationDate as the replication key for incremental syncs.
Stream containing guest reviews data from Stays. Records carry a source discriminator (internal, airbnb, bookingcom, expedia); source-specific rating/comment fields are only populated for records of that source. Uses day as the replication key for incremental syncs.
Only extracted when the Extract Reservation Details advanced setting is enabled, since it makes one extra API call per reservation.

​
Data Model

The following diagram illustrates the relationships between the core data streams in Stays. The arrows indicate the join keys that link the different entities, providing a clear overview of the data structure.

​
Skills for agents

Download Stays skills file

Stays connector documentation as plain markdown, for use in AI agent contexts.