API reference

Every endpoint

All under https://go.quarters.live/api/v1. Every endpoint but the token exchange takes Authorization: Bearer.

Authentication

OAuth 2.0 client credentials, the same grant Guesty’s Open API uses. An integration written against one needs only a different token URL. A tool that cannot keep a token, such as Zapier, Make or n8n, sends the client ID and secret as HTTP Basic on every call instead.

• POST /api/v1/oauth2/token Exchange client credentials for an access token

Listings

Property content as Publish froze it. A property never published does not exist here, and unpublished edits never show. Only the calendar is live.

• GET /api/v1/listings List every published listing
• GET /api/v1/listings/{id} Retrieve one listing
• GET /api/v1/listings/{id}/calendar Retrieve live availability

Reservations

Bookings, in every status, for contracts, accounting or a guest portal. property is the flat’s last published identity, null if it was never published; propertyId is always set. Unpublished edits never reach this response, and taking a flat off the website removes neither its bookings nor their property.

• GET /api/v1/reservations List reservations
• GET /api/v1/reservations/{id} Retrieve one reservation

Agreements

The tenancy agreement on a booking. An organisation issues its contracts in Quarters itself or in the DocuSeal account connected under Settings › Contracts. Either way the booking has one current agreement, read here. The API is read-only. When an agreement completes, a reserved booking becomes confirmed and you receive a reservation.updated webhook.

• GET /api/v1/reservations/{id}/agreement Retrieve the current agreement
• GET /api/v1/reservations/{id}/agreement/document Retrieve the archived PDF

Inquiries

Your booking form lands here as a row, linked to a guest record, that staff convert to a reservation in one click.

• POST /api/v1/inquiries Create an inquiry

Objects

• Listing A property as Publish froze it. Unpublished edits never appear here. Only the calendar is live.
• Address Where the flat is.
• Room A room of the flat. Bathrooms carry no beds; a living room may.
• Bed One kind of bed in a room, and how many.
• Image A photo, in four renditions. URLs are absolute and stable until the listing is re-published.
• Description The six prose fields of a listing. `title` is plain; the rest is the editor’s HTML.
• CalendarDay One day of a listing’s availability.
• Reservation A booking with its guest, the property’s identity, the money as agreed at booking time and the current agreement if there is one.
• ReservationStatus `option` blocks nothing; `reserved` is held; `confirmed` is firm; `cancelled` releases its days.
• PropertyIdentity The flat’s identity as last published: name, slug, address and time zone, frozen by Publish like the rest of /listings. Only `ownerName` is live. Null until the flat is first published.
• Guest The contact who made the booking. It may be an agency or an HR desk booking for someone else. `onContract` and `staying` say who.
• Party One role on a booking. `onContract` is who the tenancy agreement is made out to, `staying` who stays in the flat. Both are the contact unless the booking says otherwise.
• Agreement The tenancy agreement on a booking, in its current version.
• Signer One party to the agreement.
• InquiryInput A booking request from your form. Text is trimmed.
• TokenRequest The form posted to the token endpoint. HTTP Basic with client_id:client_secret can replace the two fields, and the form can be sent as a JSON object.
• TokenResponse A bearer token, good for 24 hours.
• Error Every failure on a resource endpoint. A 401 also carries WWW-Authenticate: Bearer.
• OAuthError How the token endpoint fails: the RFC 6749 shape OAuth client libraries read.