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 administer workspace invitations.
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 invitations list— List pending invitations.teamgrid invitations get— Get a pending invitation.teamgrid invitations create— Invite a workspace member.teamgrid invitations resend— Resend a pending invitation.teamgrid invitations cancel— Cancel a pending invitation.
teamgrid invitations list
List pending invitations.
Syntax
teamgrid invitations list [options]API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
listInvitations |
GET /invitations |
invitations:read |
List pending invitations |
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–100) | No | — | — |
--max-pages <number> |
safety limit for –all (1–10000) | No | — | 10000 |
--include-pii |
include the invited email when explicitly scoped | 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 invitations 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 invitations get
Get a pending invitation.
Syntax
teamgrid invitations get [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
getInvitation |
GET /invitations/{id} |
invitations:read |
Get a pending invitation |
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 |
|---|---|---|---|---|
--include-pii |
include the invited email when explicitly scoped | 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 invitations 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 invitations create
Invite a workspace member.
Syntax
teamgrid invitations create [options]API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
createInvitation |
POST /invitations |
invitations:write |
Invite a workspace member |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
--data <json|@file|-> |
invitation 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 invitations 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 invitations resend
Resend a pending invitation.
Syntax
teamgrid invitations resend [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
resendInvitation |
POST /invitations/{id}/resend |
invitations:write |
Resend a pending invitation |
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 invitation 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 invitations resend 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 invitations cancel
Cancel a pending invitation.
Syntax
teamgrid invitations cancel [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
cancelInvitation |
DELETE /invitations/{id} |
invitations:write |
Cancel a pending invitation |
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 invitation revision or strong ETag | Yes | — | — |
-y, --yes |
skip the destructive-operation confirmation | 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.
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 invitations cancel 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.