Matchai Docs

List appointmentsComing soon

Returns appointments in a time range, earliest first. status=requested lists what waits on the account holder’s answer.

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

Coming soon. Returns appointments in a time range, earliest first. status=requested lists what waits on the account holder’s answer.

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

Start of the range, with a UTC offset. Defaults to now.

Formatdate-time
to?string

End of the range.

Formatdate-time
status?string

Only this status.

Value in"requested""confirmed""reschedule_pending""completed""cancelled""declined""no_show"
listing_id?string

Only appointments about this listing.

contact_id?string

Only appointments with this contact.

Response Body

One page of appointments.

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/appointments'
Example Response
{  "data": [    {      "id": "string",      "title": "string",      "type": "property_viewing",      "status": "requested",      "starts_at": "2019-08-24T14:15:22Z",      "ends_at": "2019-08-24T14:15:22Z",      "duration_minutes": 5,      "timezone": "string",      "location": {        "type": "in_person",        "address": {          "formatted": "string",          "street": "string",          "unit": "string",          "city": "string",          "region": "string",          "postal_code": "string",          "country": "string"        },        "url": "http://example.com",        "phone": "string",        "note": "string"      },      "host": {        "user_id": "string",        "display_name": "string",        "team_id": "string"      },      "participants": [        {          "user_id": "string",          "contact_id": "string",          "display_name": "string",          "role": "attendee",          "status": "pending"        }      ],      "listing_ids": [        "string"      ],      "project_id": "string",      "conversation_id": "string",      "notes": "string",      "internal_notes": "string",      "source": "listing",      "proposed_starts_at": "2019-08-24T14:15:22Z",      "requested_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string"}