API support and compatibility

API families

The REST API uses the v2 endpoint family. The realtime message protocol uses its own HTTP, WebSocket, and TCP endpoints, including hosted v1 endpoint paths. These are different interfaces; a path containing v1 is not automatically an obsolete version of the REST API.

Application services power scheduling, reporting, people, and other app features. Their existence in the server does not by itself define a supported external integration contract.

Text placeholder

Publish the supported integration contract

Define public, partner-only, and internal endpoints; API and SDK compatibility; deprecation periods; error conventions; limits; pagination where supported; and the supported server versions for each example.

Authentication

Use the authentication reference for managed browser sessions and authentication concepts for bearer-token integrations. Operational roles do not grant API permissions.

Examples and versions

Check the installed server and SDK versions when adapting an example. Availability notices for native SDKs, MQTT, and mobile access require product-owner confirmation and are marked accordingly in this documentation.