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.

It also carries the key's scopes (scope, a list). Every operation names a scope as x-maat-scope, and a token whose key lacks it is refused with 403 insufficient_scope, naming the scope. Scopes are fixed when a key is issued and are re-read from the key on every request, so a key narrowed today is narrowed on its next call — the token's scope is what the key held at exchange time, for your own reading, never what authorizes a request.

x-maat-scope is the floor, and on the quick-action operations it is not the whole requirement. PUT and DELETE /listings/{listing_id}/quick-actions/{template_key} carry rules:write, and additionally require pricing:write when template_key begins pricing. — the capability depends on the template in the path, because a cleaning fee changes what a guest pays and a minimum stay does not. The refusal is the same 403 insufficient_scope, naming pricing:write. The two READS apply the same requirement without erroring: GET /listings/{listing_id}/quick-actions still lists the pricing.* rows but withholds their applied state, and GET /listings/{listing_id}/rules omits the pricing rules entirely and reports pricing_withheld in warnings. These four are the only operations in this document whose requirement is not exactly their x-maat-scope, and each of them says so machine-readably: x-maat-scope-additional lists the second scope it can require and x-maat-scope-additional-when says what happens without it.

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>
required

First day of the summary window, inclusive, over earned_on — the stay's check-in date. Required: a summary totals everything inside its window in one pass, so an unbounded one would sweep your whole history on every call.

to
string<date>
required

Last day of the summary window, inclusive. A from after to, or a window wider than 731 days, is refused with 400 validation_failed rather than truncated.

granularity
enum<string>
required

How to bucket the window.

Required rather than defaulted: the three bucket the same rows very differently, and a caller who did not say which they wanted should be told to say so.

See EarningsGranularity.

How an earnings summary is bucketed. period is always the bucket's FIRST day, so one date parser reads all three.

See EarningsGranularity.

Available options:
day,
week,
month
listing_id
string<uuid>

Only earnings on this listing. Filters inside your own workspace, so a listing that is not yours returns an empty result rather than another workspace's revenue.

Response

One bucket per period and currency, oldest first.

buckets
EarningsBucket · object[]
required

One bucket per period and currency, oldest first. There is no total across currencies anywhere in this response.