Matchai Docs

Get a listing’s visit hoursComing soon

Returns whether visits can be booked from this listing, the visit lengths offered, and the showing hours.

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

Coming soon. Returns whether visits can be booked from this listing, the visit lengths offered, and the showing hours. They narrow your own availability; they never widen it.

Scopes: calendar: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: calendar:read

Path Parameters

listing_id*string

Listing id, or its slug.

Length1 <= length <= 200

Response Body

Visit settings.

application/json
  1. response

When visitors can book a visit of this listing. It narrows your own availability; it never widens it.

enabled*boolean

Whether visits can be booked from the listing page.

durations_minutes*array<>

Visit lengths a visitor can choose.

Items1 <= items <= 6
weekly_hours*array<>

Showing hours. Empty means "whenever I am available".

Example Request
curl -X GET 'https://api.matchai.co/v1/listings/string/availability'
Example Response
{  "enabled": true,  "durations_minutes": [    5  ],  "weekly_hours": [    {      "day": "monday",      "start": "string",      "end": "string"    }  ]}