Skip to main content
Documentation

Forms

forms.templates

List the starter templates a new lead form can be built from
Read-onlyRead budget

REST

Shipping
POST /api/v1/forms/templates

MCP tool

Live
forms.templates

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

Operating contract

The shipped starting points for a lead form, each with the flow a visitor would walk through it.

USE THIS TO ANSWER 'WHAT KIND OF FORM SHOULD WE BUILD'. A template's flow is its step titles in order, which is the fastest honest way to describe what a visitor would actually be asked.

badge marks a template the product recommends. Quote the recommendation rather than picking for the shop — a form's shape depends on what they sell, and they know that.

THIS IS A SHIPPED CATALOG AND NOT THIS SHOP'S FORMS. Nothing here is live, nothing here has collected a single lead, and a template's name is not a form name. forms.list is the shop's own.

CREATING A FORM FROM ONE IS NOT A CAPABILITY. A published lead form is a page on the shop's own site collecting real people's contact details, and its wording is the shop's voice.

The whole catalog is returned, 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

FieldTypeDescription
itemsobject[]

items[].idstring

items[].namestring

items[].descriptionstring

items[].badgestring | null

items[].flowstring[]

items[].stepsnumber

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/templates \
  -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/templates", {
  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/templates",
    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.templates",
    "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.