Overview
The HeyX external API exposes workspace-scoped CRM, operations, and workspace administration methods for integrations. A tools-only Workspace MCP connection is available for supported AI clients.
Public methods use Connect JSON request bodies. Both public methods and MCP authenticate with a creator-bound workspace API key.
Base URL
Section titled “Base URL”https://your-heyx-host/public-apiConnections
Section titled “Connections”- Public API generated reference
- Authentication and exact scopes
- Workspace MCP setup and tool catalog
- Versioning and deprecation policy
Dedicated endpoint guides are organized in the sidebar for workspace context, customers, data fields, problems, work orders, members, roles, teams, invitations, correspondence, events, and advanced tasks. Guides also cover literal record search, problem/work-order templates, stock and receiving, administrative roles, and content-template catalogs and constrained drafts.
Rate limits
Section titled “Rate limits”See Rate Limits for the current hard limits and expected behavior during sustained bursts of traffic.