Skip to main content
Documentation

Integrations

integrations.list

List every connection this shop has linked, and to what
Read-onlyRead budget

REST

Shipping
POST /api/v1/integrations/list

MCP tool

Live
integrations.list

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

Operating contract

What this shop is connected to right now: the provider, which account it is linked to, when it last synced, and the last error it hit.

status of connected means the link exists — it does NOT mean it is working. A token that expired last week still reads as connected until something tries to use it. integrations.health is the read that answers 'is this actually working'.

last_synced_at is the honest health signal on this response. A connection that last synced three weeks ago on a rail that runs every fifteen minutes has stopped, whatever its status says.

last_error is what the other end said, verbatim, the last time something failed. It is often the whole answer.

NO TOKEN, REFRESH TOKEN OR SECRET IS RETURNED HERE OR ANYWHERE ELSE IN THIS REGISTRY. The columns carrying them are not read. If somebody asks for a shop's integration credentials, the answer is that no surface exposes them.

This returns every live connection the shop has, 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
itemsobject[]

items[].idstring

items[].providerstring

items[].namestring

items[].categorystring | null

items[].statusstring

items[].account_labelstring | null

items[].scopesstring[]

items[].connected_atstring

items[].last_synced_atstring | null

items[].last_errorstring | null

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/integrations/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/integrations/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/integrations/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": "integrations.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 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.