4.1.3 ユーザー関連グループ:リスト|SPIRAL PLACE API

スタッフが参加しているグループのリストを返します。

リクエスト

HTTPリクエスト

GET https://api.spiral.place/v1/users/[user_id]/groups

パラメータ

パスパラメータ

パラメータ名データ型説明
user_idstring参加グループを取得するスタッフのID
※IDの代わりに「me」を指定した場合は認可ユーザー自身のIDを指定した場合と同じ扱いになる

クエリパラメータ

パラメータ名データ型説明
limitintegerコレクションの最大件数(デフォルトは500)
offsetintegerコレクションの表示開始インデックス(デフォルトは0)
querystringグループ名検索文字列
order_bystringコレクションの表示順(昇順)(id / name)(デフォルトはid)

リクエストボディ

特になし


権限

スコープ

userのいずれか

APIを利用できるユーザー

スタッフまたはアドミン


レスポンス

プロパティ

パラメータ名データ型説明
itemslistリソースアイテムリスト
limitintegerリクエストされた上限数
offsetintegerリクエストされた開始インデックス
total_result_countinteger全件数