Skip to main content
Documentation

Integrations

integrations.available

List the connections this shop could link, and what each does
Read-onlyRead budget

REST

Shipping
POST /api/v1/integrations/available

MCP tool

Live
integrations.available

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

Operating contract

The directory: every connector this account can actually reach, with what connecting it would let the shop do.

USE THIS TO ANSWER 'CAN SERVICE VIN TALK TO X'. It is the honest list — a connector that is not here is one this account cannot connect, either because it does not exist or because the feature it serves is not available to this account yet.

THE LIST IS RING-FILTERED, and that is deliberate rather than a bug. A connector whose only destination is a screen this account cannot open would be a Connect button that leads to a dead end, and a directory row that goes nowhere is worse than no row.

status on a connector is about the CONNECTOR, not about this shop: live is built and available, and anything else is not something to promise. already_connected is the per-shop half of that question.

capabilities is what the shop gets out of connecting, in concrete terms. Quote those rather than the connector's name — 'your bookings appear in Google Calendar' is an answer; 'Google Calendar integration' is a category.

This returns the whole visible directory, 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

FieldTypeDescription
categorystringmax 40 chars

Narrow to one connector category, exactly as another row spells it.

unconnected_onlyboolean

True returns only connectors this shop has not linked yet.

Output

FieldTypeDescription
itemsobject[]

items[].idstring

items[].namestring

items[].categorystring

items[].statusstring

items[].scopestring

items[].syncstring

items[].taglinestring

items[].capabilitiesstring[]

items[].already_connectedboolean

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