Skip to main content
Documentation

Automations

automations.templates

List the automation templates a shop could switch on
Read-onlyRead budget

REST

Shipping
POST /api/v1/automations/templates

MCP tool

Live
automations.templates

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

Operating contract

The rules this product ships ready-made — the appointment confirmation, the on-my-way text, the review ask, the overdue-invoice chaser — grouped the way the gallery groups them.

USE THIS TO ANSWER 'WHAT COULD WE BE DOING', not 'what are we doing'. A template is a thing a shop COULD install; automations.list is what it actually has. Comparing the two is the useful read: a shop with no confirmation automation is a shop taking phone calls asking what time the appointment was.

key is the template's stable id and flagship: true marks the handful this product recommends first — they are the ones that pay for themselves fastest.

trigger_type is what would fire it, and it is worth quoting: a shop often has an opinion about the event that turns out to be different from the one the template listens to.

INSTALLING ONE ARMS A REAL RULE, which is why nothing here does. Tell the shop which template and where to switch it on.

This is a fixed catalogue that ships with the product, so nothing is truncated.

Who may call it

Permission
shop.manageThe caller must hold shop.manage 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
categoriesobject[]

categories[].keystring

categories[].labelstring

categories[].templatesobject[]

categories[].templates[].keystring

categories[].templates[].namestring

categories[].templates[].descriptionstring

categories[].templates[].trigger_typestring

categories[].templates[].flagshipboolean

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/automations/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/automations/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/automations/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": "automations.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 shop.manage.
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.