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

List Calendars

GET
/v1/calendars

Returns a paginated list of calendars.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

id?string

Unique identifier for the resource.

Formatuuid
id[in]?array<>

Filters by any of the supplied id values.

Itemsitems <= 10
external_id?string

Partner-owned, case-sensitive calendar identifier that is unique within the organisation.

Length1 <= length
is_default?boolean

Whether the resource is default.

scheduling_enabled?boolean

Filters resources by scheduling enabled.

limit?integer

Maximum number of resources to return.

Default10
Range0 <= value <= 100
page_token?string

Opaque token returned by a previous page request.

Length1 <= length

Response Body

application/json

curl -X GET "https://api.getmateo.com/v1/calendars"
{  "object": "list",  "data": [    {      "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"    }  ],  "next_page_url": "string",  "previous_page_url": "string"}

List Calendar Resources GET

Returns a paginated list of calendar Resources.

Update Calendar Blocked Time by External ID PATCH

Updates the row resolved by its immutable, case-sensitive external_id within this organisation. external_id cannot be changed. Repeating the same PATCH body is idempotent. Recurring masters and exceptions retain distinct locators, and exceptions reference the returned Mateo master UUID through series_id.