Authentication

The Appointedd HTTP API currently supports API key based authentication over a HTTP request header. You can find your organisation's API key in your organisation's settings.

🚧

Keep your API key safe!

Anyone with your organisation's API key can perform any operation supported by Appointedd's API on your organisation. We recommend against using our API directly from clients (such as a web application) and instead communicating with the Appointedd API from a server you control.

Authenticating a request with your API key

The example below shows how you can retrieve all the customers in your organisation with your API key in various programming languages. To get the request to work, replace <YOUR_API_KEY> with your Appointedd organisation's API key.

curl --request GET \
  --url https://api.appointedd.com/v1/customers \
  --header 'x-api-key: <YOUR_API_KEY>'

// README:
// 1. Save this to a file called `index.js`.
// 2. Fill out details in square brackets (<>).
// 3. Run `npm install axios` in the same directory.
// 4. Run `node index.js` in the same directory.
const axios = require("axios").default;

const main = async () => {
  const response = await axios.get("https://api.appointedd.com/v1/customers", {
    headers: {
      "X-API-KEY": "<YOUR_API_KEY>"
    }
  });
  
  const customers = response.data.data;
  
  console.log(customers);
};

main();