Matchai Docs

Get your availabilityComing soon

Returns your weekly hours and whether people can book time with you.

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

Coming soon. Returns your weekly hours and whether people can book time with you.

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

Response Body

Availability.

application/json
  1. response

Your weekly hours. Bookings from your listings, site and page are offered only inside them, minus what is already in your calendar.

timezone*string

IANA time zone of the schedule.

booking_enabled*boolean

Whether people can book time with you at all.

weekly_hours*array<>

Recurring hours. Several entries per day are allowed.

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