automations.list

List the shop's automation rules and which are armed

Read-onlyRead budget

REST

Shipping

POST /api/v1/automations/list

MCP tool

Live

automations.list

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

Operating contract

Every automation this shop has, with what fires it, whether it is on, and how often it has actually run.

READ master_enabled FIRST AND SAY IT. It is the shop-wide safety switch and it is NOT the same thing as a rule being on: with the master switch off and every rule enabled, nothing sends at all. A shop asking why its follow-ups stopped is usually looking at exactly this, and reporting the rules as 'on' without mentioning it is the wrong answer.

trigger_type is the event that fires the rule — a job reaching a stage, a quote being sent, an invoice going overdue. cooldown_days is how long the rule waits before it can fire again for the same customer, which is what stops a busy customer being messaged repeatedly.

run_count and last_run_at TOGETHER are the health check. An enabled rule with a run count of zero has never fired since it was created — either nothing matches it or its trigger never happens — and a rule that fired hundreds of times and then stopped a month ago is the more interesting case.

AN AUTOMATION MESSAGES CUSTOMERS. Every enabled rule on this list is a standing instruction to text or email people without anybody reviewing each send, which is why nothing here changes one.

TRUNCATION: total is the exact number of rules and omitted is how many are not in this response. When omitted is not 0, raise limit before telling a shop what it has running.

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.

Partial answers

omitted is how many matching records are not in the response, and 0 is a real answer meaning you have all of them. There is no cursor here — narrow the filter instead.

Do not summarise from a truncated response

When `omitted` is not 0 the shop has more automation rules than came back. Call again with a bigger `limit`.

Input

Field	Type	Description
enabled_only	boolean	True returns only rules that are switched on.
limit	integer1–200	How many rules to return, 1-200. Defaults to 50. Default: `50`

Output

Field	Type	Description
master_enabled	boolean	—
items	object[]	—
items[].id	string	—
items[].name	string	—
items[].description	string \| null	—
items[].trigger_type	string	—
items[].enabled	boolean	—
items[].cooldown_days	number	—
items[].step_count	number	—
items[].run_count	number	—
items[].last_run_at	string \| null	—
items[].created_at	string	—
total	number	—
omitted	number	—
enabled_count	number	—

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/list \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":50}'

TypeScript (fetch)

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

// 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/list",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "limit": 50
},
    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.list",
    "arguments": {
      "limit": 50
    }
  }
}

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 shop.manage.
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#

Partial answers#

Input#

Output#

Examples#

Refusals#