プロパティ
プロパティ名 | データ型 | 項目 | 参照のみ |
---|---|---|---|
id | integer | ID | ○ |
login_key | string | ログインキー(スタッフID) | ○ |
full_name | string | フルネーム | ○ |
full_name_kana | string | フルネーム(かな) | ○ |
last_name | string | 姓 | |
last_name_kana | string | 姓(かな) | |
first_name | string | 名 | |
first_name_kana | string | 名(かな) | |
mail_address1 | string | メールアドレス(メイン) /usersのエンドポイント以外のレスポンスには含まれません。スタッフが個人設定でメールアドレスを公開しない設定にしている場合もレスポンスに含まれません(認可ユーザーが対象スタッフ自身やアドミンの場合を除く)。 | |
mail_address2 | string | メールアドレス(サブ) /usersのエンドポイント以外のレスポンスには含まれません。スタッフが個人設定でメールアドレスを公開しない設定にしている場合もレスポンスに含まれません(認可ユーザーが対象スタッフ自身やアドミンの場合を除く)。 | |
memo | string | メモ | |
role | string | ロール staff or guest | |
is_admin | boolean | アドミンであるか true or false | |
created_datetime | datetime | 作成日時 | ○ |
updated_datetime | datetime | 更新日時 | ○ |
メソッド
メソッド名 | HTTPメソッド | パス | 処理 |
---|---|---|---|
リスト | GET | /users/ | スタッフ情報リストを返す |
取得 | GET | /users/[user_id] | 指定されたスタッフ情報を取得する |
関連リソース
リソース名 | パス | 説明 |
---|---|---|
groups | /users/[user_id]/groups | スタッフが参加しているグループのリストを返す |