Skip to content
Quarters Developers
esc
  • Type an endpoint, an object or a word from a guide.

Getting started

Quick start

Credentials, a token and your first call, in ten minutes.

The API is how a system that is not Quarters reads and writes what Quarters holds for one organisation. It is deliberately small: a website reads listings and the calendar and posts inquiries; a contract, accounting or reporting system reads reservations; a signing service reports agreements. All of them subscribe to webhooks instead of polling.

Three steps get you from nothing to a response. The base URL for everything is https://go.quarters.live/api/v1.

1. Create credentials

In the dashboard, open Settings › Integrations and create an API credential. You get a client ID (qc_…) and a client secret (qs_…). The secret is shown once; only its hash is stored, so it cannot be shown again. Lose it and you create a new set.

2. Get a token

Exchange the credentials for an access token at the token endpoint. The token lasts 24 hours. Cache it and re-use it; mint a new one when a call answers 401.

Request

curl -X POST "https://go.quarters.live/api/v1/oauth2/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=qc_YOUR_CLIENT_ID" \
  -d "client_secret=qs_YOUR_CLIENT_SECRET"

Response · 200

{
  "token_type": "Bearer",
  "access_token": "qat_…",
  "expires_in": 86400
}

3. Make your first call

Send the token as Authorization: Bearer on every call. Every published listing of your organisation, sorted by nickname:

Request

curl "https://go.quarters.live/api/v1/listings" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

An empty listings array means nothing has been published yet: the API serves what the Publish button froze, never what is being edited. Publish a property in the dashboard and call again.

Where to go next