CLI commands
Global options
Section titled “Global options”Global options can be placed before a command group.
| Option | Purpose |
|---|---|
--profile <name> |
Select a saved credential profile |
--output table|json|jsonl |
Choose human or machine-readable output |
--base-url <url> |
Override the derived regional URL for controlled staging or loopback use |
--timeout <milliseconds> |
Set the request timeout; default is 30 seconds |
--retries <0–5> |
Set bounded safe-request retries; default is 2 |
Authentication and workspace
Section titled “Authentication and workspace”teamgrid auth login [--token-stdin]teamgrid auth logoutteamgrid auth profilesteamgrid auth status [--check]teamgrid workspaceRead resources
Section titled “Read resources”teamgrid projects list|getteamgrid contacts list|getteamgrid usersteamgrid liststeamgrid servicesteamgrid tagsteamgrid audit-eventsList commands accept --limit, --cursor, --all, and --max-pages. Resource-specific filters are visible through teamgrid <command> --help.
Examples:
teamgrid projects list --completed falseteamgrid contacts list --type company --all --output jsonteamgrid audit-events --outcome denied --output jsonlteamgrid tasks list --project-id PROJECT_ID --completed falseteamgrid tasks get TASK_ID --output jsonteamgrid tasks create --data @task.json --idempotency-key task-import-42teamgrid tasks update TASK_ID --data '{"completed":true}'teamgrid tasks archive TASK_IDTime entries
Section titled “Time entries”time-entries also has the alias times.
teamgrid time-entries list --from 2026-07-01 --to 2026-07-31 --allteamgrid times get TIME_ENTRY_IDteamgrid times create --data @time-entry.json --idempotency-key time-import-42teamgrid times update TIME_ENTRY_ID --data @time-entry-patch.jsonteamgrid times archive TIME_ENTRY_IDWebhooks
Section titled “Webhooks”teamgrid webhooks listteamgrid webhooks get WEBHOOK_IDteamgrid webhooks create --data @webhook.json --idempotency-key webhook-42teamgrid webhooks remove WEBHOOK_ID--data accepts inline JSON, @path/to/file.json, or - for standard input. Archive and remove commands ask for confirmation; use --yes only in an intentionally non-interactive workflow.