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 contacts.
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 contacts list— List contacts.teamgrid contacts get— Get a contact.teamgrid contacts create— Create a contact.teamgrid contacts update— Update a contact.
teamgrid contacts list
List contacts.
Syntax
teamgrid contacts list [options]API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
listContacts |
GET /contacts |
contacts:read |
List contacts |
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 contacts | No | — | — |
--category <category> |
contact category | No | customer, supplier, team |
— |
--company-id <id> |
filter people by related company | No | — | — |
--created-by-id <id> |
filter by creator | No | — | — |
--customer-id <id> |
filter by customer identifier | No | — | — |
--group-id <id> |
filter by contact group | No | — | — |
--parent-contact-id <id> |
filter by parent contact | No | — | — |
--type <type> |
contact type | No | person, company |
— |
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 contacts 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 contacts get
Get a contact.
Syntax
teamgrid contacts get [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
getContact |
GET /contacts/{id} |
contacts:read |
Get a contact |
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 contacts 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 contacts create
Create a contact.
Syntax
teamgrid contacts create [options]API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
createContact |
POST /contacts |
contacts:write |
Create a contact |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
--data <json|@file|-> |
contact 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 contacts 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 contacts update
Update a contact.
Syntax
teamgrid contacts update [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
updateContact |
PATCH /contacts/{id} |
contacts:write |
Update a contact |
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|-> |
contact patch JSON | 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 contacts update ID --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.