ReCORE.co-api

スタッフ

スタッフ検索

概要

• スタッフの検索を行う

基本情報

• リクエストパス: GET /staffs
• JWTスコープ: staff:index
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

query

key	説明	制約など
ids	スタッフID	整数のみ、カンマ区切りで複数指定可能
codes	スタッフコード	カンマ区切りで複数指定可能
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大: 250
cursor	ページカーソル	-

例

• Request

GET /staffs?codes=SFZVXJHTBIQE

• Response

[
  {
    "id": 1,
    "code": "SFZVXJHTBIQE",
    "store": {
      "id": 1,
      "name": "本店"
    },
    "status": "ACTIVE",
    "last_name": "スタッフ",
    "last_kana": "スタッフ",
    "first_name": "太郎",
    "first_kana": "タロウ",
    "tel": "0312345678",
    "email": "staff@example.com",
    "birthdate": "1990-01-01",
    "sex": null,
    "note": null,
    "photo_url": null
  }
]

key	type	説明
*	array<object>	スタッフ一覧
*.id	int	スタッフID
*.code	string	スタッフコード
*.store	object	店舗情報
*.store.id	int	店舗ID
*.store.name	string	店舗名
*.status	string	ステータス
*.last_name	string | null	姓
*.last_kana	string | null	セイ
*.first_name	string | null	名
*.first_kana	string | null	メイ
*.tel	string | null	電話番号
*.email	string | null	メールアドレス
*.birthdate	string | null	生年月日
*.sex	string | null	性別
*.note	string | null	メモ
*.photo_url	string | null	顔写真のURL

• ステータス
  • ACTIVE 有効
  • LEAVE 停止
• 性別
  • MALE 男性
  • FEMALE 女性
  • OTHER その他

スタッフ取得

概要

• スタッフを1件取得する

基本情報

• リクエストパス: GET /staffs/{staff_id}
• JWTスコープ: staff:show
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

例

• Request

GET /staffs/44

• Response

スタッフ検索のresponse[0]と同様