Skip to main content
Documentation

Comms

comms.list_scheduled_messages

List messages queued to send later, soonest first
Read-onlyRead budget

REST

Shipping
POST /api/v1/comms/list_scheduled_messages

MCP tool

Live
comms.list_scheduled_messages

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

Operating contract

What the shop has waiting to go out, soonest first, and — with include_history — a short tail of what recently went, was pulled, or failed.

READ THIS BEFORE QUEUING ANYTHING. A follow-up somebody already scheduled is the most common way a customer gets texted twice about the same thing, and there is no idempotency key that can prevent it: the two messages are genuinely different rows queued by different callers. The check is a read, and it is cheap.

A row's status is scheduled while it waits. sent means it went; canceled means somebody pulled it; failed means the sweep tried and could not — and last_error is a sentence explaining which, most often that the customer replied STOP in the meantime.

body is the text as STORED, which on sms already has any links removed (see comms.schedule_message). It is what the customer will receive.

TRUNCATION: total is how many rows came back across both blocks and omitted how many the cap left out. This reads the queue under a fixed ceiling rather than paging, so when omitted is not 0, raise limit (up to 100) — there is no cursor.

Who may call it

Permission
inbox.accessThe caller must hold Inbox 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 there are more queued messages than these. Raise `limit` (up to 100) — this reads under a ceiling and does not page.

Input

FieldTypeDescription
include_historyboolean

True to also return recently sent, canceled and failed rows.

Default: false
limitinteger1–100

How many rows per block, 1-100. Defaults to 25.

Default: 25

Output

FieldTypeDescription
itemsobject[]

items[].idstring

items[].conversationstring | null

items[].customer_idstring | null

items[].channelstring

items[].bodystring

items[].tostring

items[].send_atstring

items[].statusstring

items[].last_errorstring | null

totalnumber

omittednumber

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/comms/list_scheduled_messages \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"include_history":false,"limit":25}'

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

// 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/comms/list_scheduled_messages",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "include_history": False,
    "limit": 25
},
    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": "comms.list_scheduled_messages",
    "arguments": {
      "include_history": false,
      "limit": 25
    }
  }
}

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 inbox.access.
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.