グループに参加しているスタッフのリストを返します。
リクエスト
HTTPリクエスト
GET https://api.spiral.place/v1/groups/[group_id]/users
パラメータ
パスパラメータ
パラメータ名 | データ型 | 説明 |
---|---|---|
group_id | string | 参加スタッフを取得するグループのID |
クエリパラメータ
パラメータ名 | データ型 | 説明 |
---|---|---|
limit | integer | コレクションの最大件数(デフォルトは500) |
offset | integer | コレクションの表示開始インデックス(デフォルトは0) |
query | string | スタッフ名、ふりがな検索文字列 |
order_by | string | コレクションの表示順(昇順)(full_name_kana / id / login_key)(デフォルトはid) |
show_only_admin | boolean | アドミンのみ表示(デフォルトはfalse) |
リクエストボディ
特になし
権限
スコープ
groupのいずれか
APIを利用できるユーザー
スタッフまたはアドミン
レスポンス
プロパティ
パラメータ名 | データ型 | 説明 |
---|---|---|
items | list | 「4.1 ユーザー」のプロパティを参照(email1、email2、password以外) |
limit | integer | リクエストされた上限数 |
offset | integer | リクエストされた開始インデックス |
total_result_count | integer | 全件数 |