店舗のスタッフ一覧取得

GET

/stores/{store_id}/staffs

• サンドボックス
• 本番

店舗のスタッフ一覧を取得します

Authorizations

• AppAccessToken
  waiter.stores:read

Parameters

Path Parameters

store_id

required

string

店舗ID

Query Parameters

limit

integer

default: 20 >= 1 <= 100

取得件数

Example

20

sort

string

default: id

ソート順

• id: スタッフID
• name: スタッフ名

パラメータ名:descで降順指定 カンマ区切りで複数指定可能

Example

id

page

integer

default: 1 >= 1

ページ番号

Example

1

display

string

default: all

Allowed values: display none all

端末上への表示/非表示設定

• display: 表示
• none: 非表示
• all: すべて

Example

all

Responses

200

OK

Array<object>

Staff

スタッフ情報

object

id

required

スタッフID

string

1

name

スタッフ名

string

山田太郎

kana

スタッフ名(カナ)

string

ヤマダタロウ

rank

ランク

string

display

端末上の表示/非表示設定

• true:表示
• false:非表示

boolean

true

Examples

[
  {
    "id": "1",
    "name": "山田",
    "kana": "ヤマダ",
    "rank": "店長",
    "display": true
  },
  {
    "id": "2",
    "name": "佐々木",
    "kana": "ササキ",
    "rank": "",
    "display": false
  },
  {
    "id": "5",
    "name": "松崎",
    "kana": "マツザキ",
    "rank": "アルバイト",
    "display": true
  }
]

Headers

Link

string

<前のURI>; rel="prev", <次のURI>; rel="next"