forms.connections

List the third-party forms posting straight into this pipeline

Read-onlyRead budget

REST

Shipping

POST /api/v1/forms/connections

MCP tool

Live

forms.connections

Exposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Forms domain.

Operating contract

The connections that let a form the shop built somewhere else — on its own website, in a page builder — post enquiries directly into this pipeline.

status of active means the rail is live. An INACTIVE connection still receives posts and drops them into the missed-payload backlog rather than creating leads, which is the single most confusing state in intake: the third-party form says 'thanks', and nothing arrives.

last_received_at is the health check. A connection that has been quiet for longer than usual is what leads.intake_health flags, and this is where you find out which one.

field_map_count is how many incoming fields have been mapped onto real lead fields. A connection receiving posts with NOTHING mapped produces leads with a name and no phone number — the enquiry arrives and nobody can answer it.

THE TOKEN IS NOT RETURNED and there is no capability that returns one. It is the credential a third party posts with, and handing it out through a machine surface is handing out the key to the shop's intake.

READ ONLY. Rotating a token silently breaks whatever is posting through it, and every enquiry after that lands in a backlog somebody has to notice.

This returns every connection the shop has, so nothing is truncated.

Who may call it

Permission: leads.accessThe caller must hold Leads at the ACT level. A read-only dashboard grant on the same section is refused.
Plan: Every planNo plan gate. Available on every Service VIN plan.
Retries: naturalNaturally idempotent — running it twice leaves the same world as running it once. A retrying integration needs no key.
Rate class: readCounted against the read budget — the widest of the four.

Input

This capability takes no arguments.

Output

Field	Type	Description
schema_missing	boolean	—
items	object[]	—
items[].id	string	—
items[].name	string	—
items[].status	string	—
items[].field_map_count	number	—
items[].last_received_at	string \| null	—
items[].created_at	string	—

Examples

Built from this capability's own schema — required fields and the ones carrying a default, and nothing invented. Paste one and it validates.

curl

export SERVICEVIN_API_KEY=svk_live_…

curl -X POST https://www.servicevin.com/api/v1/forms/connections \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

TypeScript (fetch)

const res = await fetch("https://www.servicevin.com/api/v1/forms/connections", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});

// Success and failure are both envelopes. Switch on error.code, never
// on error.message — the codes are stable, the messages are for people.
const payload = await res.json();
if (!res.ok) throw new Error(payload.error.code);
const data = payload.data;

Python (requests)

import os, requests

res = requests.post(
    "https://www.servicevin.com/api/v1/forms/connections",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={},
    timeout=30,
)
payload = res.json()
if not res.ok:
    raise RuntimeError(payload["error"]["code"])
data = payload["data"]

MCP tools/call — https://www.servicevin.com/api/mcp

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "forms.connections",
    "arguments": {}
  }
}

Refusals

The four gates run in this order on every surface, and the order is not arbitrary — see Authentication.

Status	Code	When
404	`not_found`	The id is unknown, or the feature is not enabled for this account. Deliberately the same answer for both.
403	`forbidden`	This login does not hold leads.access.
422	`validation_error`	An argument was wrong. The message names the field.
429	`rate_limited`	Too many read calls. Back off and retry.
500	`internal_error`	Something failed on our side. Nothing was changed.

Operating contract#

Who may call it#

Input#

Output#

Examples#