Generated from
@teamgrid/cli@1.0.6at Developer Platform commite6f6b47fa223. Runnode scripts/sync-cli-reference.mjs --checkto detect drift; do not edit this page manually.
read and mutate tasks.
Global options
Global options can be placed before the command group.
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
-V, --version |
output the version number | No | — | — |
-o, --output <format> |
output format | No | table, json, jsonl |
table |
--profile <name> |
credential profile | No | — | — |
--base-url <url> |
override the regional API v1 base URL | No | — | — |
--timeout <milliseconds> |
request timeout | No | — | 30000 |
--retries <count> |
safe-request retry count (0–5) | No | — | 2 |
Commands
teamgrid tasks list— List tasks.teamgrid tasks get— Get a task.teamgrid tasks create— Create a task.teamgrid tasks update— Update a task.teamgrid tasks bulk-update— update up to 35 tasks with per-item revisions; successful items remain committed.teamgrid tasks duplicate— duplicate a task and optionally its checklist and custom-field values.teamgrid tasks move— move or reorder a task in an assignee, personal, or project list.teamgrid tasks subtasks replace— atomically replace the ordered task checklist.teamgrid tasks archive— Archive a task.teamgrid tasks complete— Complete a task.teamgrid tasks restore— Restore an archived task.teamgrid tasks reopen— Reopen a completed task.teamgrid tasks timer start— Start task time tracking.teamgrid tasks timer stop— Stop task time tracking.
teamgrid tasks list
List tasks.
Syntax
teamgrid tasks list [options]API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
listTasks |
GET /tasks |
tasks:read |
List tasks |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
--all |
read every page | No | — | — |
--cursor <cursor> |
resume from an opaque cursor | No | — | — |
--limit <number> |
resources per page (1–200) | No | — | — |
--max-pages <number> |
safety limit for –all (1–10000) | No | — | 10000 |
--archived <boolean> |
return archived tasks | No | — | — |
--completed <boolean> |
filter completion | No | — | — |
--project-id <id> |
filter by project | No | — | — |
--assignee-id <id> |
filter by assignee | No | — | — |
--contact-id <id> |
filter by contact | No | — | — |
--group-id <id> |
filter by group | No | — | — |
--list-id <id> |
filter by task list | No | — | — |
--personal-list-id <id> |
filter by personal list | No | — | — |
--service-id <id> |
filter by service | No | — | — |
--subscriber-id <id> |
filter by subscriber | No | — | — |
--tag-id <id> |
filter by tag | No | — | — |
The global options and implicit -h, --help option also apply.
Output
Without --all, table output renders the page data and JSON preserves the complete page envelope. With --all, table and JSON aggregate all traversed resources while JSONL streams one resource per line.
Example
teamgrid tasks listExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.
teamgrid tasks get
Get a task.
Syntax
teamgrid tasks get [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
getTask |
GET /tasks/{id} |
tasks:read |
Get a task |
Arguments
| Argument | Required | Variadic | Choices | Default | Description |
|---|---|---|---|---|---|
id |
Yes | No | — | — | Identifier or value named by the command syntax. |
Command options
This command defines no additional options.
The global options and implicit -h, --help option also apply.
Output
The command uses the global output mode: human-readable table by default, or machine-readable json/jsonl.
Example
teamgrid tasks get IDExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.
teamgrid tasks create
Create a task.
Syntax
teamgrid tasks create [options]API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
createTask |
POST /tasks |
tasks:write |
Create a task |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
--data <json|@file|-> |
task create JSON | Yes | — | — |
--idempotency-key <key> |
stable retry key | No | — | — |
The global options and implicit -h, --help option also apply.
Output
The command uses the global output mode: human-readable table by default, or machine-readable json/jsonl.
Example
teamgrid tasks create --data @request.jsonExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.
teamgrid tasks update
Update a task.
Syntax
teamgrid tasks update [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
updateTask |
PATCH /tasks/{id} |
tasks:write |
Update a task |
Arguments
| Argument | Required | Variadic | Choices | Default | Description |
|---|---|---|---|---|---|
id |
Yes | No | — | — | Identifier or value named by the command syntax. |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
--data <json|@file|-> |
task patch JSON | Yes | — | — |
--if-match <revision|etag> |
latest task revision or strong ETag | Yes | — | — |
The global options and implicit -h, --help option also apply.
Output
The command uses the global output mode: human-readable table by default, or machine-readable json/jsonl.
Example
teamgrid tasks update ID --data @request.json --if-match REVISIONExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.
teamgrid tasks bulk-update
update up to 35 tasks with per-item revisions; successful items remain committed.
Syntax
teamgrid tasks bulk-update [options]API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
bulkUpdateTasks |
POST /tasks/bulk-update |
tasks:write |
Update multiple tasks safely |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
--data <json|@file|-> |
JSON with ordered items containing id, revision, and data | Yes | — | — |
The global options and implicit -h, --help option also apply.
Output
The command uses the global output mode: human-readable table by default, or machine-readable json/jsonl.
Example
teamgrid tasks bulk-update --data @request.jsonExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.
teamgrid tasks duplicate
duplicate a task and optionally its checklist and custom-field values.
Syntax
teamgrid tasks duplicate [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
duplicateTask |
POST /tasks/{id}/duplicate |
tasks:read |
Duplicate a task |
Arguments
| Argument | Required | Variadic | Choices | Default | Description |
|---|---|---|---|---|---|
id |
Yes | No | — | — | Identifier or value named by the command syntax. |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
--data <json|@file|-> |
task duplication JSON | Yes | — | — |
--if-match <revision|etag> |
latest source task revision or strong ETag | Yes | — | — |
--idempotency-key <key> |
stable retry key | No | — | — |
The global options and implicit -h, --help option also apply.
Output
The command uses the global output mode: human-readable table by default, or machine-readable json/jsonl.
Example
teamgrid tasks duplicate ID --data @request.json --if-match REVISIONExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.
teamgrid tasks move
move or reorder a task in an assignee, personal, or project list.
Syntax
teamgrid tasks move [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
moveTask |
POST /tasks/{id}/move |
tasks:write |
Move or reorder a task |
Arguments
| Argument | Required | Variadic | Choices | Default | Description |
|---|---|---|---|---|---|
id |
Yes | No | — | — | Identifier or value named by the command syntax. |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
--data <json|@file|-> |
task placement JSON | Yes | — | — |
--if-match <revision|etag> |
latest task revision or strong ETag | Yes | — | — |
The global options and implicit -h, --help option also apply.
Output
The command uses the global output mode: human-readable table by default, or machine-readable json/jsonl.
Example
teamgrid tasks move ID --data @request.json --if-match REVISIONExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.
teamgrid tasks subtasks replace
atomically replace the ordered task checklist.
Syntax
teamgrid tasks subtasks replace [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
replaceTaskSubtasks |
PUT /tasks/{id}/subtasks |
tasks:write |
Replace a task checklist |
Arguments
| Argument | Required | Variadic | Choices | Default | Description |
|---|---|---|---|---|---|
id |
Yes | No | — | — | Identifier or value named by the command syntax. |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
--data <json|@file|-> |
checklist replacement JSON | Yes | — | — |
--if-match <revision|etag> |
latest task revision or strong ETag | Yes | — | — |
The global options and implicit -h, --help option also apply.
Output
The command uses the global output mode: human-readable table by default, or machine-readable json/jsonl.
Example
teamgrid tasks subtasks replace ID --data @request.json --if-match REVISIONExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.
teamgrid tasks archive
Archive a task.
Syntax
teamgrid tasks archive [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
archiveTask |
DELETE /tasks/{id} |
tasks:write |
Archive a task |
Arguments
| Argument | Required | Variadic | Choices | Default | Description |
|---|---|---|---|---|---|
id |
Yes | No | — | — | Identifier or value named by the command syntax. |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
-y, --yes |
skip the destructive-operation confirmation | No | — | — |
--if-match <revision|etag> |
latest task revision or strong ETag | Yes | — | — |
The global options and implicit -h, --help option also apply.
Output
The command uses the global output mode: human-readable table by default, or machine-readable json/jsonl.
Confirmation and automation
This command can change or remove data and asks for confirmation by default. In a reviewed non-interactive job, pass --yes or set TEAMGRID_CLI_ASSUME_YES=1; otherwise the command exits with code 2. Cancelling an interactive confirmation exits with code 0.
Example
teamgrid tasks archive ID --if-match REVISIONExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.
teamgrid tasks complete
Complete a task.
Syntax
teamgrid tasks complete [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
completeTask |
POST /tasks/{id}/complete |
tasks:write |
Complete a task |
Arguments
| Argument | Required | Variadic | Choices | Default | Description |
|---|---|---|---|---|---|
id |
Yes | No | — | — | Identifier or value named by the command syntax. |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
--if-match <revision|etag> |
latest task revision or strong ETag | Yes | — | — |
The global options and implicit -h, --help option also apply.
Output
The command uses the global output mode: human-readable table by default, or machine-readable json/jsonl.
Example
teamgrid tasks complete ID --if-match REVISIONExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.
teamgrid tasks restore
Restore an archived task.
Syntax
teamgrid tasks restore [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
restoreTask |
POST /tasks/{id}/restore |
tasks:write |
Restore an archived task |
Arguments
| Argument | Required | Variadic | Choices | Default | Description |
|---|---|---|---|---|---|
id |
Yes | No | — | — | Identifier or value named by the command syntax. |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
--if-match <revision|etag> |
latest task revision or strong ETag | Yes | — | — |
The global options and implicit -h, --help option also apply.
Output
The command uses the global output mode: human-readable table by default, or machine-readable json/jsonl.
Example
teamgrid tasks restore ID --if-match REVISIONExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.
teamgrid tasks reopen
Reopen a completed task.
Syntax
teamgrid tasks reopen [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
reopenTask |
POST /tasks/{id}/reopen |
tasks:write |
Reopen a completed task |
Arguments
| Argument | Required | Variadic | Choices | Default | Description |
|---|---|---|---|---|---|
id |
Yes | No | — | — | Identifier or value named by the command syntax. |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
--if-match <revision|etag> |
latest task revision or strong ETag | Yes | — | — |
The global options and implicit -h, --help option also apply.
Output
The command uses the global output mode: human-readable table by default, or machine-readable json/jsonl.
Example
teamgrid tasks reopen ID --if-match REVISIONExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.
teamgrid tasks timer start
Start task time tracking.
Syntax
teamgrid tasks timer start [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
startTaskTimer |
POST /tasks/{id}/timer/start |
tasks:write |
Start task time tracking |
Arguments
| Argument | Required | Variadic | Choices | Default | Description |
|---|---|---|---|---|---|
id |
Yes | No | — | — | Identifier or value named by the command syntax. |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
--user-id <id> |
workspace user whose timer should start | Yes | — | — |
--at <date> |
start timestamp; defaults to the API receive time | No | — | — |
The global options and implicit -h, --help option also apply.
Output
The command uses the global output mode: human-readable table by default, or machine-readable json/jsonl.
Example
teamgrid tasks timer start ID --user-id IDExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.
teamgrid tasks timer stop
Stop task time tracking.
Syntax
teamgrid tasks timer stop [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
stopTaskTimer |
POST /tasks/{id}/timer/stop |
tasks:write |
Stop task time tracking |
Arguments
| Argument | Required | Variadic | Choices | Default | Description |
|---|---|---|---|---|---|
id |
Yes | No | — | — | Identifier or value named by the command syntax. |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
--user-id <id> |
workspace user whose timer should stop | Yes | — | — |
--at <date> |
stop timestamp; defaults to the API receive time | No | — | — |
The global options and implicit -h, --help option also apply.
Output
The command uses the global output mode: human-readable table by default, or machine-readable json/jsonl.
Example
teamgrid tasks timer stop ID --user-id IDExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.