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

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

リクエスト

HTTPリクエスト

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

パラメータ

パスパラメータ

パラメータ名データ型説明
group_idstring参加スタッフを取得するグループのID

クエリパラメータ

パラメータ名データ型説明
limitintegerコレクションの最大件数(デフォルトは500)
offsetintegerコレクションの表示開始インデックス(デフォルトは0)
querystringスタッフ名、ふりがな検索文字列
order_bystringコレクションの表示順(昇順)(full_name_kana / id / login_key)(デフォルトはid)
show_only_adminbooleanアドミンのみ表示(デフォルトはfalse)

リクエストボディ

特になし


権限

スコープ

groupのいずれか

APIを利用できるユーザー

スタッフまたはアドミン


レスポンス

プロパティ

パラメータ名データ型説明
itemslist4.1 ユーザー」のプロパティを参照(email1、email2、password以外)
limitintegerリクエストされた上限数
offsetintegerリクエストされた開始インデックス
total_result_countinteger全件数