Documentation
Tasks
tasks.list
REST
ShippingPOST /api/v1/tasks/listMCP tool
Livetasks.listExposed 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
Input
| Field | Type | Description |
|---|---|---|
| status | string | `open` is the working queue; `done` covers completed and cancelled; `all` is both. Default:"open"One of: open, done, all |
| staff_id | stringuuid | Only this teammate's tasks, as returned by tasks.assignees. |
| conversation | stringuuid | Only this thread's tasks, as returned by comms.list_conversations. |
| overdue_only | boolean | True for open tasks whose due date has passed. Overrides status. Default:false |
| limit | integer1–100 | How many tasks to return, 1-100. Defaults to 25. Default:25 |
| offset | integermin 0 | How many to skip. Pass the previous response's next_offset to continue. Default:0 |
Output
| Field | Type | Description |
|---|---|---|
| items | object[] | — |
| items[].id | string | — |
| items[].title | string | — |
| items[].notes | string | null | — |
| items[].status | string | — |
| items[].priority | string | — |
| items[].due_at | string | null | — |
| items[].overdue | boolean | — |
| items[].completed_at | string | null | — |
| items[].created_at | string | — |
| items[].conversation | string | null | — |
| items[].conversation_label | string | null | — |
| items[].customer_id | string | null | — |
| items[].job_id | string | null | — |
| items[].message_id | string | null | — |
| items[].assigned_to | string | null | — |
| items[].assignee_name | string | null | — |
| total | number | — |
| omitted | number | — |
| next_offset | number | 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.
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}'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;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"]{
"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.
| 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 inbox.access. |
| 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. |