Getting started

Quickstart

Create a token in the Clearooms portal, then call the API with it. It takes a few minutes.

1. Create an API token

  1. Sign in to the portal and open Settings → Apps & Integrations → API, or go straight to portal.clearooms.com/settings/account/api.
  2. Give the token a descriptive name, so you know later what it's for, such as "HR system sync".
  3. Select Create.

The API page in the Clearooms portal, with a Token Name field and a Create button

The token is shown once. Copy it and store it somewhere safe, such as your secrets manager.

The "Your new API key" dialog, which shows the new token once

2. Make your first request

All endpoints live under one base URL:

https://api.clearooms.com/api/v1

Send the token as a Bearer token, and ask for JSON. GET /users/me returns the account the token belongs to:

curl
export CLEAROOMS_TOKEN="paste-your-token-here"

curl https://api.clearooms.com/api/v1/users/me \
  -H "Authorization: Bearer $CLEAROOMS_TOKEN" \
  -H "Accept: application/json"
JavaScript (Node 18+)
const res = await fetch('https://api.clearooms.com/api/v1/users/me', {
  headers: {
    Authorization: `Bearer ${process.env.CLEAROOMS_TOKEN}`,
    Accept: 'application/json',
  },
});
console.log(await res.json());
Python
import os, requests

res = requests.get(
    "https://api.clearooms.com/api/v1/users/me",
    headers={
        "Authorization": f"Bearer {os.environ['CLEAROOMS_TOKEN']}",
        "Accept": "application/json",
    },
)
print(res.json())

3. Book a desk

Find a desk with GET /desks/availability, then book it with POST /bookings:

curl https://api.clearooms.com/api/v1/bookings \
  -X POST \
  -H "Authorization: Bearer $CLEAROOMS_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "desk_id": "573657f8-ad17-49eb-95ce-d0f2b8515900",
    "date": "2025-05-08 08:00:00",
    "all_day": true
  }'

Next steps