店舗のスタッフ一覧取得

GET

/stores/{store_id}/staffs

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/waiter/stores/example/staffs?limit=20&sort=id&page=1&display=all';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/waiter/stores/example/staffs?limit=20&sort=id&page=1&display=all' \
  --header 'Authorization: Bearer <token>'

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

Authorizations

AppAccessToken
waiter.stores:read

Parameters

Path Parameters

store_id

required

string

店舗ID

Query Parameters

limit

integer

default: 20 >= 1 <= 100

取得件数

Example

sort

string

default: id

ソート順

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

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

Example

id

page

integer

default: 1 >= 1

ページ番号

Example

display

string

default: all

Allowed values: display none all

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

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

Example

all

Responses

200

application/json

Array<object>

Staff

スタッフ情報

object

required

スタッフID

string

name

スタッフ名

string

kana

スタッフ名(カナ)

string

rank

ランク

string

display

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

true:表示
false:非表示

boolean

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"