Skip to main content
Documentation

Tasks

tasks.list

List the shop's inbox tasks — open, overdue, mine or one thread's
Read-onlyRead budget

REST

Shipping
POST /api/v1/tasks/list

MCP tool

Live
tasks.list

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

Operating contract

The shop's to-do queue in the order it is worked: OPEN first (soonest due, undated last, then newest), then finished (most recently cleared first). That ordering is the answer to two different questions in one list — what is next, and what did we just clear.

FOUR LENSES, and they compose. status picks open / done / all. staff_id narrows to one person's queue. conversation narrows to one thread's tasks — the right call when you are about to reply and want to know what was already promised. overdue_only overrides status, because an overdue finished task is a contradiction rather than an empty result.

overdue on a row is computed at read time from due_at against now — it is not a stored flag, so it is always current.

Each result's id is the task_id that tasks.get and tasks.update take. conversation is the thread for comms.list_messages; customer_id, job_id and message_id are what customers.get, jobs.get and comms.get_message take. A task that carries all four is the shop's own cross-reference and is worth following before answering anything about it.

TRUNCATION: total is the exact number of tasks the lens holds and omitted how many are NOT in this response. 'How much is on our list' must be answered from total — a model reporting items.length on a shop with three hundred open tasks tells the owner the queue is empty enough to ignore. When omitted is not 0, call again with offset set to next_offset.

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. Continue with next_offset.

Do not summarise from a truncated response

When `omitted` is not 0 you have part of the queue. Use `total` for counts, and call again with `offset` set to `next_offset` for the rest.

Input

FieldTypeDescription
statusstring

`open` is the working queue; `done` covers completed and cancelled; `all` is both.

Default: "open"One of: open, done, all
staff_idstringuuid

Only this teammate's tasks, as returned by tasks.assignees.

conversationstringuuid

Only this thread's tasks, as returned by comms.list_conversations.

overdue_onlyboolean

True for open tasks whose due date has passed. Overrides status.

Default: false
limitinteger1–100

How many tasks to return, 1-100. Defaults to 25.

Default: 25
offsetintegermin 0

How many to skip. Pass the previous response's next_offset to continue.

Default: 0

Output

FieldTypeDescription
itemsobject[]

items[].idstring

items[].titlestring

items[].notesstring | null

items[].statusstring

items[].prioritystring

items[].due_atstring | null

items[].overdueboolean

items[].completed_atstring | null

items[].created_atstring

items[].conversationstring | null

items[].conversation_labelstring | null

items[].customer_idstring | null

items[].job_idstring | null

items[].message_idstring | null

items[].assigned_tostring | null

items[].assignee_namestring | null

totalnumber

omittednumber

next_offsetnumber | null

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/tasks/list \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"open","overdue_only":false,"limit":25,"offset":0}'

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

// 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/tasks/list",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "status": "open",
    "overdue_only": False,
    "limit": 25,
    "offset": 0
},
    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": "tasks.list",
    "arguments": {
      "status": "open",
      "overdue_only": false,
      "limit": 25,
      "offset": 0
    }
  }
}

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.