グループのリストを返します。
リクエスト
HTTPリクエスト
GET https://api.spiral.place/v1/groups/パラメータ
パスパラメータ
特になし
クエリパラメータ
| パラメータ名 | データ型 | 説明 |
|---|---|---|
| limit | integer | コレクションの最大件数（デフォルトは500） |
| offset | integer | コレクションの表示開始インデックス（デフォルトは0） |
| query | string | グループ名検索文字列 |
| order_by | string | コレクションの表示順（昇順）（name / id）（デフォルトはid） |
リクエストボディ
特になし
権限
スコープ
group.manageまたはgroup
APIを利用できるユーザー
スタッフまたはアドミン
レスポンス
プロパティ
| パラメータ名 | データ型 | 説明 |
|---|---|---|
| items | list | 「4.3 グループ｜SPIRAL PLACE API」のプロパティ参照 |
| limit | integer | リクエストされた上限数 |
| offset | integer | リクエストされた開始インデックス |
| total_result_count | integer | 全件数 |