Matchai Docs

Find your free slotsComing soon

Returns the times you are free on one day for an appointment of this length: your hours, minus your appointments and the busy times of a connected calendar.

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

Coming soon. Returns the times you are free on one day for an appointment of this length: your hours, minus your appointments and the busy times of a connected calendar. With listing_id, the listing’s visit hours narrow them further.

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

Query Parameters

date*string

The day.

Formatdate
duration_minutes*integer

Appointment length.

Range5 <= value <= 480
listing_id?string

Apply this listing’s visit hours.

Response Body

Free 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/availability/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"    }  ]}