Machine Access
Use the REST API, KPI endpoint, MCP connector and Bulk Actions for supported CRM operations. Availability and permissions depend on the action.
Run Next Stage Now is workspace-only. Other documented chase interventions retain their action-specific API permissions.
The CRM has its own addresses for the first three. They serve exactly the same data as the /backend/ forms, governed by exactly the same permissions. They exist so a CRM-only user has an obvious address to point an integration at, without needing to know about the billing backend.
The three addresses
Section titled “The three addresses”| Address | What it is | Full documentation |
|---|---|---|
/crm/api/v1/ | The REST API | API Reference |
/crm/kpi/ | The KPI endpoint for dashboard tools | KPI Reporting |
/crm/mcp | The MCP connector for AI assistants | AI Assistants |
The /backend/api/v1/, /backend/kpi/ and /backend/mcp addresses provide the same access. Pick whichever suits the integration; there is no difference in what comes back.
One thing that does differ: an assistant connection made through /crm/mcp is approved on the CRM sign-in, so a CRM-only user can approve it themselves. Connect and revoke them from Account Security.
What an assistant can do in the CRM
Section titled “What an assistant can do in the CRM”An AI assistant can read every CRM record family, and where the right access levels are granted at approval, work the sales process and Credit Control end to end.
The CRM write scopes:
| Scope | Allows |
|---|---|
Pre-Sales (sales:write) | Moving and closing deals, generating and sending proposals, working deal products |
Credit Control (credit-control:write) | Working chase cases, recording promises, managing holds |
Outreach (outreach:send) | Replying on cases and steering the email queue |
Two high-impact actions need more than the CRM scope:
- Bringing a deal live also needs the Service Lifecycle access level.
- Writing off a chase case also needs the Financial access level.
And every write capability stays switched off platform-wide until an administrator enables it on the MCP settings user, so granting a scope at approval is never enough on its own.
An assistant also inherits the connected user’s own CRM sections and permissions. Case replies are a good example: an assistant working as a user without CRM Case Sending writes drafts, which a person then reviews and sends.
CRM KPI categories
Section titled “CRM KPI categories”These categories answer reporting questions without listing every record:
| Category | Covers |
|---|---|
crmDeals | Deal counts and values |
crmProposals | Proposals sent, accepted and by month |
crmCases | Open cases, by category and section |
crmChaseCases | Open cases and legacy settlement/recovery snapshots |
crmChaseMeasurements | Cohorts grouped by first actionable assessment, starting value and actual net collections |
crmChaseCollections | Actual net collections grouped by payment date, including refunds |
crmSequences | Active and stopped enrolments, and reply rates |
crmEmailQueue | Sends, failures and traffic by campaign |
They reuse each object’s own access rules, so a KPI query never totals anything the user could not list.
Use each category’s supported dimensions and interval options. The measured Credit Control categories provide assessment/payment periods, starting pipeline, owner, currency and opening baseline.
Select population as all, new or baseline. scope defaults to own; team requires Credit Control team access. Date filters use assessment dates for crmChaseMeasurements and payment dates for crmChaseCollections.
See Results and Analytics for the distinction between cash, non-cash changes and legacy outcomes.
Bulk Actions for CRM records
Section titled “Bulk Actions for CRM records”Bulk Actions extends to six CRM record types, from the usual Expert menus:
- Deals
- Proposals
- Chase cases
- Sequence enrolments
- Email queue items
- Stock numbers
The first five are customer-scoped, matched the way any other customer-scoped bulk file is. Stock numbers are matched by lookup and have to be opted into.
The standard Bulk Actions workflow applies: files are tested before they are applied, they run in the background with live progress, every row reports its own result, and the whole run is audited.
API keys
Section titled “API keys”Create or replace your API key in Account Security. You need API access and must complete the account and authenticator checks.
A key never gains access beyond its user’s permissions. Ask an administrator to check user access if the action is unavailable.