Developers

Full API reference

Where the exact shapes live, and why they are not restated here.

About 2 minutes

The authoritative reference is the API Reference page inside the app. It is generated against your workspace, so it shows the real request and response shapes — including any custom objects and fields you have added, which no static document could know about.

Why this page does not restate it

A second copy of an API contract is a second thing to keep correct, and the copy is always the one that goes stale. Anything written here about exact field names would eventually contradict the app, and a reader has no way to tell which is right.

What is public

  • CRM — accounts, contacts, leads (including convert), opportunities, activities
  • Studio apps — list and execute registered actions

Objectives, chat, campaigns and the Hub are not public API surfaces. To start work externally, use a routine webhook; to file something in, use the inbound webhook.

Checked against

  • pages/crm.api.tsx
  • endpoints/v1/