Introduction
Send your first request to the hellomateo API and continue into the detailed guides when you need them.
API overview
The hellomateo API is REST-oriented. It uses predictable resource URLs, standard HTTP methods and status codes, HTTPS-only requests, and JSON responses.
Use this page as the shortest path to a working request. It introduces only the essentials: the API origin, the headers every request needs, and where to go next for endpoint-specific details.
Base URL
https://api.getmateo.comEndpoint paths in the API reference include the /v1 prefix, for example /v1/contacts.
API paths are strict. Use endpoint paths exactly as documented and do not add a trailing slash: /v1/contacts is valid, while /v1/contacts/ returns 404 Not Found.
Send your first request
Create an API token in hellomateo, send it as a bearer token, and include the current API version header. The contacts list endpoint is a good read-only request to try first:
curl "https://api.getmateo.com/v1/contacts" \
--header "Authorization: Bearer <your_api_token>" \
--header "hellomateo-version: 2026-07-01"If the request succeeds, continue in the API reference for endpoint-specific parameters and response shapes. For list endpoints, read Pagination; for optional related data, read Include-dependent responses.
If the request fails, check whether your API token and version header are present. Error responses include a stable code and a request_id; use Errors and Request IDs when debugging or contacting support.