Documentation
Forms
forms.get
REST
ShippingPOST /api/v1/forms/getMCP tool
Liveforms.getExposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Forms domain.
Operating contract
One form's structure: every step in order, what kind of step it is, and the question it puts in front of a visitor.
WHAT A FORM ASKS FOR IS THE PRODUCT DECISION IN THIS DOMAIN. Every extra question costs completions, and the order matters more than the count — a phone number asked on step one loses people who would have given it on step four. Reading the steps beside forms.funnel is how that shows up as a number rather than an opinion.
The CONTACT step is always last and is where the lead's actual details are captured. A visitor who reaches it and does not finish is somebody who wanted the quote and balked at handing over their number.
A review step, when the form has one, is a confirmation screen at the end. It is optional and a form without one simply ends on contact.
Refuses when no form in this shop has that id, including one that has been deleted.
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
| Field | Type | Description |
|---|---|---|
| form_idrequired | stringuuid | The form's id, as returned by forms.list. |
Output
| Field | Type | Description |
|---|---|---|
| id | string | — |
| name | string | — |
| slug | string | — |
| status | string | — |
| template | string | null | — |
| submission_count | number | — |
| last_submission_at | string | null | — |
| steps | object[] | — |
| steps[].id | string | — |
| steps[].title | string | — |
| steps[].kind | string | — |
| has_review_step | boolean | — |
Examples
Built from this capability's own schema — required fields and the ones carrying a default, and nothing invented. Paste one and it validates.
export SERVICEVIN_API_KEY=svk_live_…
curl -X POST https://www.servicevin.com/api/v1/forms/get \
-H "Authorization: Bearer $SERVICEVIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"form_id":"9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"}'const res = await fetch("https://www.servicevin.com/api/v1/forms/get", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"form_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
}),
});
// 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;import os, requests
res = requests.post(
"https://www.servicevin.com/api/v1/forms/get",
headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
json={
"form_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
},
timeout=30,
)
payload = res.json()
if not res.ok:
raise RuntimeError(payload["error"]["code"])
data = payload["data"]{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "forms.get",
"arguments": {
"form_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
}
}
}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. |