ユーザーのリストを返します。
リクエスト
HTTPリクエスト
GET https://api.spiral.place/v1/users※スコープによって取得できるフィールドは変化します。
パラメータ
パスパラメータ
特になし
クエリパラメータ
| パラメータ名 | データ型 | 説明 |
|---|---|---|
| limit | integer | コレクションの最大件数（デフォルトは500） |
| offset | integer | コレクションの表示開始インデックス（デフォルトは0） |
| query | string | 名前、ふりがな検索文字列 |
| order_by | string | コレクションの表示順（昇順）（full_name_kana / id / login_key）（デフォルトはid） |
| show_only_admin | boolean | アドミンのみ表示（デフォルトはfalse） |
| group | integer | 所属するグループのID |
リクエストボディ
特になし
権限
スコープ
user
APIを利用できるユーザー
スタッフまたはアドミン
レスポンス
プロパティ
| パラメータ名 | データ型 | 説明 |
|---|---|---|
| items | list | リソースアイテムリスト |
| limit | integer | リクエストされた上限数 |
| offset | integer | リクエストされた開始インデックス |
| total_result_count | integer | 全件数 |