❗️ PLEASE NOTE: Appointedd currently has two versions of our API:
🔎 What is an API
An API allows developers to pull information from applications and to push information into said applications from other tools and systems, without having to do it manually.
For example, you could automatically create a customer in Appointedd when one is created in your own CRM or you could update your staff's working hours in your HR system when they're updated in Appointedd.
Building into an API is technical work so will require a developer. Our API is organised around JSON, with requests and responses both accepting and producing application/json data types.
👀 How is API V2 different from the original Appointedd API
Appointedd API V2 is built entirely within our new tech stack, which supports cross account operations to ensure we’re building APIs and products to suit our customers' business needs. This means that the customer's developers will be able to query data (such as bookings and customers) from all their accounts with a single API call, and without requiring the management of many API keys.
We’re also moving to a new authentication strategy - oAuth2 authentication, which makes it possible to create multiple “API Clients”, allowing developers to rotate or delete existing API credentials, which offers increased security. Only admins of accounts will be able to create and manage API credentials, and the created credentials will only authenticate against accounts which they are also an admin on.
You can see the full documentation on our API V2 here.
🧮 What are the current capabilities of API V2
Currently, the first iteration of Appointedd's API V2 covers only the GET endpoints (Read Only operations).
Here are some of the capabilities:
Get all, or search for matching customers across all authenticated accounts (or a specific account);
Get all account names and slugs;
Get all, or search for matching bookings across all authenticated accounts;
Get all, or search for matching events across all authenticated accounts etc.
Please note: we will continue to develop the API V2 further so that our customers can utilise more endpoints in their operations.
However, if there are any specific endpoints that you would like to see sooner than later, please submit your feedback here so that we can prioritise them accordingly.
⚙️ How can I use API V2
In order to set up API clients to include one or more accounts, you will need to have administrator permissions on the relevant accounts.
There are two ways to access API V2:
Go to the Connect tab on your account -> Set up an API connection -> API V2;
Or you can access it directly from your hallway if you are a user on more than 1 account - simply click on the Manage OAuth API button above the list of all your accounts.
Setting up your API Clients:
Click on the +Create New API button;
Add your Client name, Description (optional) and select your Permissions - which accounts this client will be restricted to.
Click Save.
The system will create your new API Client and will provide your unique Client ID and Client Secret that you will need to copy to store on your side.
❗️ PLEASE NOTE: For security reasons the Client Secret will only ever be shown once after a new client is created and there will be no other way to retrieve it again. If you forget or lose it, you will need to regenerate it.
Viewing and managing API Clients:
You will be able to view any API Client that has been set up with the accounts that you have access to. However, only the person who created an API client will be able to edit or delete it. Please note that these actions are irreversible.
To view a specific API client, simply click on the client's name.
