curl --fail-with-body https://maatstays.wtf/v1/properties/3c9d1f42-7b60-4a18-9e55-0d2a6f8c31b7/photos \
-H "Authorization: Bearer $MAAT_PARTNER_TOKEN"
const res = await fetch(
'https://maatstays.wtf/v1/properties/3c9d1f42-7b60-4a18-9e55-0d2a6f8c31b7/photos',
{ headers: { Authorization: `Bearer ${process.env.MAAT_PARTNER_TOKEN}` } },
);
const body = await res.json();
if (!res.ok) throw new Error(`${body.code}: ${body.detail}`);
for (const photo of body.items) {
console.log(photo.position, photo.state, photo.url ?? photo.rejection_reason);
}
import os
import requests
res = requests.get(
"https://maatstays.wtf/v1/properties/3c9d1f42-7b60-4a18-9e55-0d2a6f8c31b7/photos",
headers={"Authorization": f"Bearer {os.environ['MAAT_PARTNER_TOKEN']}"},
timeout=30,
)
body = res.json()
if res.status_code >= 400:
raise RuntimeError(f"{body['code']}: {body.get('detail')}")
for photo in body["items"]:
print(photo["position"], photo["state"], photo["url"] or photo["rejection_reason"])
package main
import (
"encoding/json"
"fmt"
"log"
"net/http"
"os"
)
type photo struct {
PhotoID string `json:"photo_id"`
Position int `json:"position"`
IsCover bool `json:"is_cover"`
State string `json:"state"`
RejectionReason *string `json:"rejection_reason"`
URL *string `json:"url"`
}
func main() {
req, _ := http.NewRequest(http.MethodGet,
"https://maatstays.wtf/v1/properties/3c9d1f42-7b60-4a18-9e55-0d2a6f8c31b7/photos",
nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("MAAT_PARTNER_TOKEN"))
res, err := http.DefaultClient.Do(req)
if err != nil {
log.Fatal(err)
}
defer res.Body.Close()
if res.StatusCode >= 400 {
log.Fatalf("photo read failed: %d", res.StatusCode)
}
var body struct {
Items []photo `json:"items"`
}
if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
log.Fatal(err)
}
for _, p := range body.Items {
fmt.Println(p.Position, p.State, p.URL)
}
}
List a property's photos
Every photo on the property, in the order guests see them. Position 0 is the
cover.
This is how you follow an upload. A photo you presigned appears here
immediately as pending; it becomes ready once we have processed and reviewed
it, or rejected with a reason from a closed vocabulary. Poll this rather than
assuming a successful upload means a published image — the review happens after
you are gone.
url is the published image and is null in every other state. A photo our
automated review declined reads as rejected, not ready: its file exists and
no guest will ever be shown it.
A property with more than one unit, or more than one listing, is refused with
409 property_not_simple.
Live in a sandbox workspace. Returns 501 against a production one.
curl --fail-with-body https://maatstays.wtf/v1/properties/3c9d1f42-7b60-4a18-9e55-0d2a6f8c31b7/photos \
-H "Authorization: Bearer $MAAT_PARTNER_TOKEN"
const res = await fetch(
'https://maatstays.wtf/v1/properties/3c9d1f42-7b60-4a18-9e55-0d2a6f8c31b7/photos',
{ headers: { Authorization: `Bearer ${process.env.MAAT_PARTNER_TOKEN}` } },
);
const body = await res.json();
if (!res.ok) throw new Error(`${body.code}: ${body.detail}`);
for (const photo of body.items) {
console.log(photo.position, photo.state, photo.url ?? photo.rejection_reason);
}
import os
import requests
res = requests.get(
"https://maatstays.wtf/v1/properties/3c9d1f42-7b60-4a18-9e55-0d2a6f8c31b7/photos",
headers={"Authorization": f"Bearer {os.environ['MAAT_PARTNER_TOKEN']}"},
timeout=30,
)
body = res.json()
if res.status_code >= 400:
raise RuntimeError(f"{body['code']}: {body.get('detail')}")
for photo in body["items"]:
print(photo["position"], photo["state"], photo["url"] or photo["rejection_reason"])
package main
import (
"encoding/json"
"fmt"
"log"
"net/http"
"os"
)
type photo struct {
PhotoID string `json:"photo_id"`
Position int `json:"position"`
IsCover bool `json:"is_cover"`
State string `json:"state"`
RejectionReason *string `json:"rejection_reason"`
URL *string `json:"url"`
}
func main() {
req, _ := http.NewRequest(http.MethodGet,
"https://maatstays.wtf/v1/properties/3c9d1f42-7b60-4a18-9e55-0d2a6f8c31b7/photos",
nil)
req.Header.Set("Authorization", "Bearer "+os.Getenv("MAAT_PARTNER_TOKEN"))
res, err := http.DefaultClient.Do(req)
if err != nil {
log.Fatal(err)
}
defer res.Body.Close()
if res.StatusCode >= 400 {
log.Fatalf("photo read failed: %d", res.StatusCode)
}
var body struct {
Items []photo `json:"items"`
}
if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
log.Fatal(err)
}
for _, p := range body.Items {
fmt.Println(p.Position, p.State, p.URL)
}
}
Authorizations
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.
Path Parameters
Maat's identifier for the property, as returned by GET /properties. Not your
own provider_id — the write endpoint is the one keyed on that, which is why
this read carries a by-id segment.
Response
The property's photos, cover first.
Every photo on the property, in display order, whatever state it is in.
Show child attributes
Show child attributes