Beta — endpoints, schemas, limits and examples may change before general availability.
Hellomateo API Documentation
Working with the API

Request IDs

Use request IDs from response headers and error responses when debugging API requests.

The API returns a request ID with each response in the Request-Id header. Keep this value when logging API calls, debugging failures, or contacting hellomateo support.

Request-Id: 3f31b3d8-9f1e-4c7f-8b6f-0123456789ab

Error responses also include the same value in the JSON request_id field so it is available even when you are inspecting only the response body.

{
  "name": "APIError",
  "message": "Unsupported hellomateo-version header",
  "code": "INVALID_VERSION_HEADER",
  "is_transient": false,
  "timestamp": "2026-01-01T00:00:00.000Z",
  "status_code": 400,
  "contact_support": false,
  "request_id": "3f31b3d8-9f1e-4c7f-8b6f-0123456789ab"
}

The header and body field identify the same request.

When you contact hellomateo support about a failed API request, include:

  • the Request-Id response header or request_id error field
  • the endpoint and HTTP method
  • the timestamp from the error response, when available
  • the error code, when available