Release Candidate — the API is undergoing final validation before general availability, and minor changes may still occur.
Hellomateo API Documentation
DocumentationAPI Reference
Calendars

Create Calendar

POST
/v1/calendars

Creates a virtual calendar. Provider-backed calendars cannot be created through the public API.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

id?string

Unique identifier for the resource.

Formatuuid
name*string

Human-readable name of the resource.

Length1 <= length
type*"virtual"

Type of the resource.

scheduling_enabled?boolean

Scheduling Enabled value for this resource.

calendar_resource_id?string

Unique identifier of the related calendar resource.

Formatuuid
calendar_resource_external_id?string

Unique identifier of the related calendar resource external.

Length1 <= length
opening_hours?array<>

Opening Hours value for this resource.

external_id?|

Identifier assigned by an external system.

Response Body

application/json

curl -X POST "https://api.getmateo.com/v1/calendars" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "type": "virtual"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "external_id": "string",  "calendar_resource_id": "b91c4c5a-de69-4276-8281-8d05c6c9e77d",  "type": "provider",  "is_default": true,  "scheduling_enabled": true,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Create Calendar Blocked Time POST

Creates a manual blocked time. Public partner creates remain source: manual even when external_id is provided; source: external is reserved for provider synchronization. Optional external_id values are partner-owned, trimmed, case-sensitive, immutable synchronization locators that are unique within this organisation. POST is create-only: a duplicate returns a conflict, and after an ambiguous timeout clients should GET /v1/blocked-times/by by external_id before retrying. A recurring master and every exception require distinct external_id values; create the master first, then use its returned Mateo id as the exception series_id.

Delete Calendar Blocked Time by External ID DELETE

Deletes the row resolved by its immutable, case-sensitive external_id within this organisation. A repeated DELETE may return 404 after the first success; clients may treat that response as the desired already-absent state.