Reservit connection guide
Finding Your Reservit API Key and Connecting ItReserve Modules
A complete, step-by-step guide to locating your Reservit API credentials, understanding API permission scopes, and successfully connecting your first ItReserve module.
What is a Reservit API key and why does ItReserve need it?
The Reservit PMS (Property Management System) exposes a published, documented REST API that allows authorised third-party applications to read and — on certain scopes — write data to your Reservit account. This API is the only mechanism through which Reservit officially supports external integrations. An API key is a long alphanumeric credential that Reservit issues to your account; it identifies your property and authorises specific scopes of data access.
ItReserve modules connect to your Reservit account exclusively through this official API. No module stores a copy of your full reservation database — instead, each module makes real-time API calls to Reservit whenever it needs to read or update data. This means your Reservit account remains the single source of truth for all your property data. ItReserve never accesses your Reservit back-office directly, never stores your Reservit username or back-office credentials, and cannot make changes that Reservit's API does not explicitly permit.
The API key grants ItReserve the ability to perform only what each module is designed to do. For example, the Analytics Board module requests only read-level access to reservation and rate data. The Housekeeping Pro module requests read access to arrival/departure data and write access to room status fields. The specific scopes required for each module are documented in the module description on the catalogue page and in the dashboard's API connection panel. You should confirm that the scopes required by your chosen modules are enabled on your Reservit API plan before completing your ItReserve purchase.
Reservit API access is available on their Professional plan and above. If you are on a lower tier, contact your Reservit account manager or reseller and request API access to be enabled. Some resellers handle API key issuance on behalf of their customers; if you are unsure whether you have an API key, the steps below will help you check.
How to find your Reservit API key
The exact navigation path may vary slightly depending on your Reservit version and plan, but the following steps apply to the current Reservit back-office interface.
Open your Reservit back-office
Navigate to your Reservit back-office URL — typically provided by Reservit during onboarding (format: yourproperty.reservit.com or a custom domain assigned by your Reservit reseller). Enter your Reservit administrator credentials on the login page. You must be logged in as an account administrator or a user with API management permissions to access the API key section.
Navigate to account settings
Once inside the back-office, look for a gear icon or the word "Settings" in the top-right corner of the main navigation bar. Click it to open the account settings menu. The settings area is distinct from the property configuration area — it contains account-level options including user management, billing, and API access.
Open the Integrations or API tab
Within the Settings panel, look for a tab or sidebar item labelled "Integrations", "API", "Developer" or "Third-party connections". The exact label depends on your Reservit version. In the current Reservit 2024 interface this is listed as "Integrations" under the Development section of the settings sidebar. Older Reservit back-office versions may label this section "API Access" or "External Connections".
Locate or generate your API key
On the Integrations page you should see a section labelled "API keys" or "Access tokens". If a key has already been generated for your account, it will be listed here — typically with a partial display showing only the first and last four characters for security, with a copy button. If no key exists, click "Generate new API key" or "Create token". Reservit may ask you to select permission scopes at this point — select all scopes required by the ItReserve modules you intend to use (see the permissions section below). Give the key a descriptive name such as "ItReserve integration" so you can identify it later.
Copy the full API key value
Click the copy button next to the API key. Important: Reservit typically shows the full key only once, immediately after generation. If you close the page or navigate away, the full key will no longer be visible — only a masked version. If you did not copy the key in time, you will need to delete the old key and generate a new one. Paste the copied key immediately into a temporary secure location (such as your password manager) before switching to the ItReserve dashboard to enter it.
Confirm the key is active
After generating and copying the key, confirm it shows a status of "Active" in the Reservit API keys list. Some Reservit configurations require an administrator to approve newly generated keys before they become active. If the status shows "Pending approval", contact your Reservit account administrator or reseller to approve the key. Once the status is "Active", the key is ready to use in ItReserve.
Connecting your first ItReserve module
Once you have your Reservit API key, connecting your first ItReserve module takes less than 5 minutes. After completing your purchase on the ItReserve catalogue, check your inbox for the order confirmation email. It contains a link that takes you directly into your ItReserve dashboard — click it, and you will land on the setup screen for the module you purchased.
On the setup screen, locate the "Reservit API key" field and paste in the key you copied from your Reservit back-office. Then click "Verify and connect". ItReserve will immediately send a test request to the Reservit API using your key. If the key is valid and the required scopes are active, you will see a "Connected" confirmation within 5 seconds and the module will begin its initial data sync. If verification fails, an error message will explain the cause — see the troubleshooting section below for the most common error types and their resolutions.
After the initial sync completes (typically 2–20 minutes depending on your property's reservation history), navigate to the module's dashboard tab to confirm data is appearing correctly. For the Analytics Board, this means seeing chart data populated with your recent reservation history. For Guest Comms, this means seeing upcoming reservations listed in the trigger queue. If data appears correct, your integration is working as expected. If anything looks wrong — missing data, unexpected figures, or no data at all — check the module's activity log in the dashboard for error entries and consult our support team if needed.
Common Reservit connection errors
Error: "Invalid API key"
The key you entered does not match any active API key on the Reservit account. This usually means the key was copied incorrectly — check for leading or trailing spaces, which are often introduced when copying from a browser. Delete the contents of the API key field and paste fresh from your clipboard. If the error persists, return to your Reservit back-office and confirm the key is still listed and marked as "Active". If the key was deleted in Reservit, generate a new one and enter the new value in the ItReserve dashboard.
Error: "Insufficient permissions" or "Scope not authorised"
The API key is valid, but it does not have the permission scopes required by the module you are trying to connect. Return to your Reservit back-office, find the API key in the Integrations section, and check the scopes that are enabled on it. Compare against the required scopes listed in the permissions section above. If the required scope is missing, you may need to generate a new API key with the correct scopes (some Reservit configurations do not allow editing scopes on existing keys) or contact your Reservit account administrator to adjust the key's permissions.
Error: "Account not found" or "Property ID mismatch"
ItReserve cross-references the API key against the Reservit account email you provided at checkout. If your Reservit account email has changed since purchase, or if you entered a different email at checkout, this validation can fail. Go to your ItReserve dashboard settings, update the Reservit account email field to match the current primary email on your Reservit account, then re-enter your API key and verify again. If the error continues, contact ItReserve support with your Reservit account email and your order reference.
Error: "Rate limit exceeded"
Reservit's API enforces rate limits that vary by plan. If you have multiple ItReserve modules making simultaneous API calls — for example, during an initial sync — you may briefly hit the rate limit. ItReserve handles rate limit responses gracefully by queuing and retrying requests, so this error typically resolves itself within 1–2 minutes without any action required on your part. If you see this error persistently (more than 30 minutes), contact support — this may indicate a configuration issue causing excessive API requests.
Error: "API access not enabled on your Reservit plan"
This error means the Reservit account associated with your API key does not have API access enabled at the plan level. This is different from an individual API key being inactive — it means the API feature itself is locked on your Reservit subscription tier. Contact your Reservit account manager or reseller and request that API access be activated on your plan. This is typically a same-day change. Once Reservit has activated API access on your account, return to the ItReserve dashboard and click "Verify connection" again.
Keeping your Reservit account secure
Your Reservit API key grants significant access to your property data. Treat it with the same care you would treat a master password. Do not share your API key by email, paste it into chat messages, or commit it to version-controlled code repositories. If you suspect your API key has been compromised — for example, if you accidentally pasted it somewhere public — log in to your Reservit back-office immediately, delete the compromised key, and generate a new one. Then update the key in your ItReserve dashboard. The old key will stop working the moment it is deleted in Reservit, protecting your account from unauthorised use.
Reservit recommends rotating API keys every 90 days as a routine security practice. ItReserve makes key rotation straightforward: generate a new key in Reservit, update the stored key in your ItReserve dashboard, verify the connection, and delete the old key in Reservit. The entire process takes under 5 minutes. Consider scheduling this rotation as a quarterly calendar reminder for your property IT administrator.
Use the minimum necessary scopes when generating your API key. If you are only using ItReserve modules that require read access — such as Analytics Board and Guest Comms — there is no reason to add write scopes to the key. A read-only key cannot be used to modify your reservation data or rates even if ItReserve were somehow compromised. Review the permissions section of this guide and grant only the scopes that the specific modules you have purchased actually require. You can always generate a new key with additional scopes later if you purchase a module that needs write access.
Frequently asked questions
Can I use the same Reservit API key for multiple ItReserve modules?
Yes. A single Reservit API key — provided it has the required scopes for each module — can power all your ItReserve modules simultaneously. Enter the key once in the ItReserve dashboard's API Connection panel and it will be applied to every active module on your account. You do not need to generate a separate key for each module. If different modules require different scope sets and your Reservit configuration does not allow adding multiple scopes to one key, you can generate separate keys for separate modules and assign them individually in the dashboard.
Will ItReserve modules keep working if my Reservit account is temporarily suspended?
No. ItReserve modules communicate with Reservit's live API for every data request. If your Reservit account is suspended — due to a billing issue with Reservit, for example — all API calls will fail and your ItReserve modules will report connection errors. The modules themselves will not be cancelled or damaged; they will resume normal operation as soon as your Reservit account is restored and the API key becomes active again. ItReserve subscription billing is separate from your Reservit billing and will continue regardless of your Reservit account status.
Does ItReserve need access to my Reservit back-office login?
No. ItReserve never requires your Reservit username or back-office password. The integration works entirely through the Reservit API using an API key — a separate credential that you generate yourself in your Reservit back-office and control at all times. If you ever want to revoke ItReserve's access to your Reservit account, simply delete the API key in Reservit — no other action is required. ItReserve modules will immediately lose access to your Reservit data when the key is deleted.
How do I know if my Reservit plan includes API access?
The simplest test is to navigate to the Integrations or API section of your Reservit back-office settings (as described in the steps above) and attempt to generate an API key. If the option is greyed out, blocked, or you see a message indicating API access is not included in your plan, your current Reservit plan does not include API access. In this case, contact your Reservit account manager or the reseller who manages your Reservit subscription and ask for the API feature to be enabled. Reservit's Professional and Enterprise tiers include API access by default. If you are unsure of your tier, check your Reservit invoice or ask your account manager.
Ready to connect your modules?
Purchase your first ItReserve module and follow these steps to go live with your Reservit integration today.
Browse modules Ask support a question