The Amenitiz API lets another system connect to your Amenitiz account and read your property's data — your rooms, rates, availability, bookings and invoices.
You would use it if you want to connect Amenitiz to an external tool, or if a developer is building an integration for your property. Setting it up is technical work: you or a developer working with you will need to write code.
Before you start
The Amenitiz API is in beta and is still being rolled out, so some details may still change.
The API is available on the Advanced plan only, and only the account owner can create or manage API credentials. Team members cannot.
What the API can read
When you create a credential you choose what it is allowed to read, from six areas:
Room types and rooms
Rates and offers
Availability calendar
Bookings and guest details
Bills, invoices and payouts
Property settings and team
The last three cover personal and sensitive data, so tick them only when the tool genuinely needs them.
What the API cannot do
It cannot change anything in your account. The API only reads data. Rates, availability, bookings and settings are all changed in Amenitiz itself.
It does not cover everything you see in Amenitiz. Some data is only available in the platform.
Amenitiz does not provide technical support for API implementations. The API is an advanced integration provided on a self-service basis.
Step by step
To get started:
Check that your property is on the Advanced plan and that you are the account owner.
Create your API credentials in
Settings→API credentials. Amenitiz generates a Client ID and a secret.Give the Client ID and secret to your developer, or paste them into the tool you are connecting.
Point your developer to the technical documentation at developers.amenitiz.com.
Here's a video showing the step-by-step process:
Do I need a developer to use the API?
Do I need a developer to use the API?
In most cases, yes. The API is a technical interface, so either a developer works with you, or the tool you are connecting already supports the Amenitiz API. You do not need a developer to create the credentials themselves.
Can the API change my rates, availability or bookings?
Can the API change my rates, availability or bookings?
No. The API only reads data. Every change to your rates, availability, bookings or settings has to be made in Amenitiz.
What is the difference between the API and the Marketplace?
What is the difference between the API and the Marketplace?
The Marketplace holds ready-made connections to tools Amenitiz already works with, and you activate them yourself with no code. The API is for connecting a tool that has no ready-made connection, and it needs development work.
I am on the Advanced plan but I cannot see API credentials
I am on the Advanced plan but I cannot see API credentials
The API is still being rolled out, so it may not have reached your account yet. Check that you are signed in as the account owner, then contact our support team.
