Matchai Docs

List roomsComing soon

Returns the rooms and spaces of the property, in page order.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
GET
/listings/{listing_id}/spaces

Coming soon. Returns the rooms and spaces of the property, in page order.

Scopes: listings:read

Pricing: Included with the connection.

Authorization

headerAuthorizationBearer <matchai_<base62>>

A personal API key, sent as Authorization: Bearer matchai_…. Create keys in Matchai under Settings → Connectors → Advanced (for developers). A key starts with matchai_ followed by letters and digits, carries the scopes chosen when it was created, and can be revoked at any time. Keys reach only the account that created them: to serve other professionals, use Connect with Matchai.

Scope: listings:read

Path Parameters

listing_id*string

Listing id, or its slug.

Length1 <= length <= 200

Query Parameters

locale?string

Return text in this language when a translation exists, the original text otherwise.

Value in"en-US""fr-CA""es"

Response Body

All rooms.

application/json
  1. response
data*array<>

In page order.

Example Request
curl -X GET 'https://api.matchai.co/v1/listings/string/spaces'
Example Response
{  "data": [    {      "id": "string",      "listing_id": "string",      "type": "string",      "name": "string",      "floor_level": "string",      "width": 0,      "depth": 0,      "dimension_unit": "feet",      "flooring": "string",      "notes": "string",      "position": 0    }  ]}