Skip to main content

REST API

Work in progress

A complete, supported REST reference is being prepared. Today, the recommended way to integrate programmatically is the MCP server. The notes below describe the shape of the API the Zoie app uses; treat endpoint paths as informational until this page is finalized.

Conventions​

  • Base URL — per environment (production https://app.zoie.ai, etc.); the API is served under the /api/v1/... path prefix.
  • Format — JSON request and response bodies.
  • Auth — bearer access token; see Authentication.
  • Context — requests are scoped to the acting user and selected business.

Surfaces​

The platform is organized into domains such as:

  • Auth & account — sign-in, password, OTP/2FA, current user, businesses
  • Leads — leads, custom views, custom fields
  • Conversations — messages and chats
  • Appointments — booking and availability
  • Campaigns & forms — broadcasts and form submissions
  • AI agents & voice — agent configuration and call activity
  • MCP grants — managing connected assistants

Planned​

  • Per-endpoint request/response schemas
  • Pagination, filtering, and error conventions
  • Rate limits