Matchai Docs

List days off and special hoursComing soon

Returns one-day exceptions to your weekly hours, earliest first.

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

Coming soon. Returns one-day exceptions to your weekly hours, earliest first.

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

limit?integer

How many results per page.

Range1 <= value <= 100
Default25
cursor?string

The next_cursor of the previous page. Cursors expire after 24 hours.

Lengthlength <= 512
from?string

First day. Defaults to today.

Formatdate
to?string

Last day.

Formatdate

Response Body

One page of overrides.

application/json
  1. response

One page of results. Pass next_cursor as cursor to get the next page; it is null on the last page.

data*array<>
next_cursor*|

Cursor for the next page, or null when there are no more results.

Example Request
curl -X GET 'https://api.matchai.co/v1/availability/overrides'
Example Response
{  "data": [    {      "id": "string",      "date": "2019-08-24",      "available": true,      "start": "string",      "end": "string",      "reason": "string"    }  ],  "next_cursor": "string"}