API credentials are like a username and password that let another system connect to your Amenitiz account and read your property's data, such as your rooms, rates, availability, bookings and invoices. A credential only ever reads: nothing connected this way can change anything in Amenitiz.

You would use them if you want to connect Amenitiz to an external tool, or if a developer is building an integration for your property. New to the API? Start with How to understand the Amenitiz API.

Before you start

The Amenitiz API is in beta and is still being rolled out, so some details may still change.

To create API credentials you need to be on the Advanced plan and be the account owner. Team members cannot create or manage credentials.

Have your Amenitiz password to hand — you will be asked for it to finish.

Step by step

Go to Settings.
Open API credentials.
Click New credential.
Give the credential a name you will recognise later — for example the tool you are connecting, like "Accounting export".
Under What can it read?, tick only what the tool actually asked for — you must tick at least one. You can change this later.
If you have more than one property, tick which ones the credential covers under Which properties?. With a single property there is nothing to choose.
Click Create credential.
Enter your Amenitiz password when Check it's you appears, then click Create credential again.
Copy the Client ID and the secret, or click Download as file to save them.
Click Done.

📌 Note

There is nothing to memorise. If you lose the secret, open the credential again and Amenitiz will show it to you after checking your password.

You can now give the Client ID and secret to your developer, or paste them into the tool you are connecting.

Choosing what a credential can read

A credential only reads what you tick, so tick only what the tool asked for. The six options are:

Room types and rooms — your property details, your room types and the individual rooms in them.
Rates and offers — rate plans, extras, promotions and sales terms.
Availability calendar — day by day: what is free, the price, and any minimum stay.
Bookings and guest details — reservations, charges and payments, including each guest's name, email, phone and address, and anything they wrote in their request.
Bills, invoices and payouts — the bills, invoices and credit notes you have issued, including your customers' billing details, and your payout account.
Property settings and team — check-in times, automated emails, and your team's names, emails and permissions.

🚫 Warning

The last three options cover personal and sensitive data. Your guests never agreed to share their details with the tool you are connecting — you are deciding for them. Tick Bookings and guest details, Bills, invoices and payouts and Property settings and team only when the tool genuinely needs them.

Managing your credentials

Open a credential and you can:

Copy the Client ID.
Show the secret — see it again, and Hide it when you are done.
Replace the secret — swap the current secret for a new one. Do this if you think your secret has been shared or leaked. The Client ID stays the same — only the secret changes — and any tool still using the old secret loses access until you paste the new one in.
Revoke the credential — permanently switch it off. Amenitiz asks you to type the credential’s name to confirm, then any tool using it loses access straight away.
Change what the credential can read, by ticking or unticking the same six options, and change which properties it covers.

⚠️ Important

Amenitiz asks you to confirm your account password before showing or replacing a secret. The secret gives access to your property's data, so we check it is really you first.

📌 Note

Taking access away applies straight away, and the tool is signed out until it connects again. Adding access only reaches the tool the next time it connects.

Keeping your credentials safe

Treat your secret like a password:

Never share it publicly, and never send it in an unsecured email or chat message.
Only give it to tools and people you trust.
If you think it has been exposed, replace it straight away.

For developers

The full technical documentation is at developers.amenitiz.com.

Amenitiz does not provide technical support for API implementations. The API is an advanced integration provided on a self-service basis.

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.

Can a team member create API credentials?

No. Only the account owner can create a credential, show or replace a secret, or revoke a credential.

I have lost my secret. What do I do?

Open the credential and click Show, then confirm your account password. Nothing is lost — you only need to replace the secret if you think someone else has seen it.

Can I change what a credential can read after I have created it?

Yes. Open the credential and tick or untick the options. Removing access applies straight away; adding access reaches the tool the next time it connects.

Should I create one credential per tool?

Yes. A separate credential for each tool means you can replace or revoke one without cutting off the others, you can give each tool only the access it needs, and you can see at a glance which tool a credential belongs to.

I revoked a credential by mistake. Can I switch it back on?

No. Revoking is permanent. Create a new credential and give the new Client ID and secret to the tool or developer.

How to create and manage your API credentials