Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

A short-lived partner token, obtained by exchanging your API key at POST /token. Send it as Authorization: Bearer <access_token>.

Tokens live for fifteen minutes by default and never for more than an hour. Mint one per batch of work, not one per request.

The token carries the workspace and the environment its key was issued for. You cannot change either by asking: the exchange ignores everything in the request body for exactly that reason.

Never send it as a cookie or in a query string, and never store it — store the API key, mint tokens from it.

Query Parameters

from
string<date>

Only blocks holding a night on or after this date. A block whose check_out is this date holds no night in the window, so it is not returned.

to
string<date>

Only blocks holding a night on or before this date.

page
integer
default:1

1-based page number. Defaults to the first page.

Required range: x >= 1
page_size
integer
default:50

Rows per page.

Required range: 1 <= x <= 200

Response

One page of your blocks.

items
Block · object[]
required
has_more
boolean
required

Whether another page exists. There is no total: counting the whole set to answer one page is work neither of us needs.