指定したトピックの参加ユーザーグループのリストを返します。
リクエスト
HTTPリクエスト
GET https://api.spiral.place/v1/messages/[message_id]/user_groups/パラメータ
パスパラメータ
| パラメータ名 | データ型 | 説明 |
|---|---|---|
| message_id | string | 参加グループを取得するトピックのID |
クエリパラメータ
| パラメータ名 | データ型 | 説明 |
|---|---|---|
| limit | integer | コレクションの最大件数（デフォルトは500） |
| offset | integer | コレクションの表示開始インデックス（デフォルトは0） |
| order_by | string | コレクションの表示順（昇順）（id / name）（デフォルトはid） |
リクエストボディ
特になし
権限
スコープ
message.manageまたはmessage
APIを利用できるユーザー
該当トピックの閲覧権限のあるスタッフ
レスポンス
プロパティ
| パラメータ名 | データ型 | 説明 |
|---|---|---|
| items | list | 「4.3 グループ｜SPIRAL PLACE API」のプロパティを参照 |
| limit | integer | リクエストされた上限数 |
| offset | integer | リクエストされた開始インデックス |
| total_result_count | integer | 全件数 |