Skip to main content
Documentation

Forms

forms.list

List the shop's lead forms and how many have been submitted
Read-onlyRead budget

REST

Shipping
POST /api/v1/forms/list

MCP tool

Live
forms.list

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

Operating contract

Every lead form this shop has built, most recently changed first, with whether it is live and how much work it has brought in.

status of published means the public can reach it at its slug. A draft is invisible to everybody outside the shop, and a campaign pointed at a draft is a campaign spending on nothing.

submission_count is how many people FINISHED. It is not how many started, and the gap between those two is usually the whole story — forms.funnel is the read that shows it.

last_submission_at is the more useful field of the two. A published form with a healthy total and nothing for six weeks has stopped working, and the total will keep looking fine indefinitely.

step_count includes the contact step, which every form ends on.

Every id here is what forms.get and forms.funnel take.

This returns up to a hundred forms in one call — more than any real 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

FieldTypeDescription
published_onlyboolean

True returns only forms the public can currently reach.

Output

FieldTypeDescription
itemsobject[]

items[].idstring

items[].namestring

items[].slugstring

items[].statusstring

items[].templatestring | null

items[].step_countnumber

items[].submission_countnumber

items[].last_submission_atstring | null

items[].updated_atstring

totalnumber

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/list \
  -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/list", {
  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/list",
    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.list",
    "arguments": {}
  }
}

Refusals

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

StatusCodeWhen
404not_foundThe id is unknown, or the feature is not enabled for this account. Deliberately the same answer for both.
403forbiddenThis login does not hold leads.access.
422validation_errorAn argument was wrong. The message names the field.
429rate_limitedToo many read calls. Back off and retry.
500internal_errorSomething failed on our side. Nothing was changed.