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

Update Appointment

PATCH
/v1/appointments/{id}

Custom fields can be written as additional top-level properties using each custom field key. Values are validated against the field definitions returned by List Custom Fields.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Unique identifier for the resource.

Formatuuid

Query Parameters

include_details?array<string>

Dynamic detail fields to include. Use repeated query syntax: include_details=foo&include_details=bar.

Itemsitems <= 10

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Human-readable name of the resource.

Length1 <= length
raw_description?|

Raw Description value for this resource.

external_id?|

Identifier assigned by an external system.

status_key?string

Status Key value for this resource.

Length1 <= length
type_key?string

Type Key value for this resource.

Length1 <= length
contact_id?string

Unique identifier of the related contact.

Formatuuid
start_time?string

Start Time value for this resource.

Formatdate-time
end_time?|

End Time value for this resource.

confirmed_at?|

Timestamp for confirmed at.

cancelled_at?|

Timestamp for cancelled at.

calendar_id?string

Calendar for the appointment. When omitted during appointment creation, the organisation default calendar is used.

Formatuuid
[key: string]?unknown

Response Body

application/json

curl -X PATCH "https://api.getmateo.com/v1/appointments/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "property1": null,    "property2": null  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "raw_description": "string",  "external_id": "string",  "status_key": "string",  "type_key": "string",  "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",  "start_time": "2019-08-24T14:15:22Z",  "end_time": "2019-08-24T14:15:22Z",  "confirmed_at": "2019-08-24T14:15:22Z",  "cancelled_at": "2019-08-24T14:15:22Z",  "calendar_id": "c828ce68-4c5a-4491-b76a-af3d888d3f97",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "property1": null,  "property2": null}

Update Appointment By Locator PATCH

Custom fields can be written as additional top-level properties using each custom field `key`. Values are validated against the field definitions returned by List Custom Fields.

List Audit Logs GET

Lists audit logs for the API token organisation in descending occurred_at order. Every valid API token may read these logs, and entity permissions do not filter events. Queries for one subject require both subject_type and subject_id; all other queries require an RFC 3339 time range in occurred_at[gte] and occurred_at[lte]. Follow next_page_url until it is null and treat event IDs as stable deduplication keys.