TeamGriddeveloper
TeamGrid Developer

teamgrid search

1 executable @teamgrid/cli commands in the search group, generated from CLI 1.0.6.

Generated from @teamgrid/cli@1.0.6 at Developer Platform commit e6f6b47fa223. Run node scripts/sync-cli-reference.mjs --check to detect drift; do not edit this page manually.

search permitted TeamGrid resources.

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 search query

Search authorized TeamGrid resources.

Syntax

teamgrid search query [options]

API operation and scope

Operation HTTP Scope API reference
searchResources POST /search search:read Search authorized TeamGrid resources

Command options

Option Description Required Choices Default
--data <json|@file|-> search request 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 search query --data @request.json

Exit 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.

Stable documentation · Developer Experience · Reviewed 2026-08-10Edit this page ↗
Documentation feedbackWas this page useful?
Esc

Search TeamGrid Developer

Find guides, concepts and every API operation.