スタッフ一覧取得

GET

/staffs

• サンドボックス
• 本番

スタッフ情報一覧を取得します。

対象プラン

• スタンダード
• プレミアム
• プレミアムプラス
• フードビジネス
• リテールビジネス

Authorizations

• AppAccessToken
  pos.staffs:read
• UserAccessToken
  pos.staffs:read

Parameters

Query Parameters

fields

array

検索パラメータ（カンマ区切りで指定可）
Response項目を指定可能
※一部項目(withで指定する項目、2階層目以降の項目)については指定不可

sort

string

並び順（カンマ区切りで指定可）

指定可能なパラメータ

• staffId：スタッフId
• staffCode：スタッフコード
• rank：ランク
• displaySequence：表示順
• updDateTime：更新日時

limit

integer

上限数

page

integer

ページ

staff_id

integer

スタッフID

user_id

integer

ユーザー識別子：契約ID内において一意なユーザー識別子

staff_code

string

スタッフコード

role_id

string

役割・役職ID

rank

string

ランク

login_staff_flag

string

Allowed values: 0 1 2 3

ログインフラグ（0：ログイン不可、1：ログイン可、2：認証待ち、3：停止）

display_flag

string

Allowed values: 0 1

表示フラグ（0：表示しない、1：表示する）

Responses

200

取得成功

Array<object>

object

staffId

スタッフID：半角数字5桁以内。

string

staffCode

スタッフコード：半角英数20文字以内。

string

staffName

スタッフ名：50文字以内。

string

staffNameKana

スタッフ名カナ：50文字以内。

string

rank

ランク：85文字以内。

string

displayFlag

表示フラグ：表示フラグ。 （0：表示しない、1：表示する）

string

displaySequence

表示順：半角数字9桁以内。

string

loginStaffFlag

ログインフラグ：ログインフラグ。（0：ログイン不可、1：ログイン可、2：認証待ち、3：停止）

string

email

メールアドレス。

string format: email

/(?:[_p{L}0-9][-_p{L}0-9]*.)*(?:[p{L}0-9][-p{L}0-9]{0,62}).(?:(?:[a-z]{2}.)?[a-z]{2,})$/ui/

loginIpAddress

ログイン許可IPアドレス。

string

//^[0-9\.]+$//

roleId

役割・役職ID：半角数字11桁以内。

string

insDateTime

作成日時：登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

updDateTime

更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

Example

[
  {
    "staffId": "string",
    "staffCode": "string",
    "staffName": "string",
    "staffNameKana": "string",
    "rank": "string",
    "displayFlag": "string",
    "displaySequence": "string",
    "loginStaffFlag": "string",
    "email": "test@example.com",
    "loginIpAddress": "string",
    "roleId": "string",
    "insDateTime": "string",
    "updDateTime": "string"
  }
]