list_groups
Retrieve every group for a tenant by tenant ID, including member and destination counts. Optionally expand to full member lists and notification destinations when contact details are required.
Instructions
テナントに紐づく現場(グループ)の一覧を取得します。
tenant_id は list_tenants で取得してください。
必要な権限レベル: 制限なし(どのユーザーレベルでも実行できます)。
既定で間引く項目:
member(所属ユーザー。メールアドレスを含む)→ member_count のみ。全量は include_members=true
destination(通知先。メールアドレスを含む)→ destination_count のみ。全量は include_destinations=true
children → has_children (bool) に置換。API 仕様上つねに空配列で、 子現場の詳細を取得する操作は提供されていないため、階層構造の完全な取得はできません
dashboard_id(単数形・未使用項目)→ 返しません。dashboard_ids を参照してください
このエンドポイントはページングに対応していないため、常に全件を返します。 現場の最大階層レベルは max_group_level として返します。
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| lang | No | レスポンスの言語(ja / en) | ja |
| tenant_id | Yes | テナントID(UUID)。list_tenants で取得できる | |
| include_members | No | 現場所属ユーザー(member)の全量を含める。メールアドレスを含む | |
| include_destinations | No | 現場の通知先(destination)の全量を含める。メールアドレスを含む |