Matchai Docs

Find bookable slotsComing soon

Returns the times anyone can book with this professional on one day — the same times their listing pages and Matchai Page offer.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
GET
/professionals/{username}/booking-slots

Coming soon. Returns the times anyone can book with this professional on one day — the same times their listing pages and Matchai Page offer. With listing_id, the times for a visit of that listing. Returns no slots when they do not accept bookings. It never reveals what is in their calendar.

Scopes: none — public. An API key or token is optional and raises your rate limit.

Pricing: Free. No connection needed.

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.

Path Parameters

username*string

The professional’s public handle.

Match^[a-z0-9][a-z0-9_-]{1,38}$

Query Parameters

date*string

The day.

Formatdate
duration_minutes*integer

Length. For a listing, one of its visit lengths.

Range5 <= value <= 480
listing_id?string

A published listing of theirs.

Response Body

Bookable slots.

application/json
  1. response
date*string

The day asked for.

Formatdate
timezone*string

Time zone the slots are offered in.

duration_minutes*integer

Length asked for.

Range5 <= value
slots*array<>

Free slots, earliest first.

Example Request
curl -X GET 'https://api.matchai.co/v1/professionals/string/booking-slots?date=2019-08-24&duration_minutes=5'
Example Response
{  "date": "2019-08-24",  "timezone": "string",  "duration_minutes": 5,  "slots": [    {      "starts_at": "2019-08-24T14:15:22Z",      "ends_at": "2019-08-24T14:15:22Z"    }  ]}