従業員事業所取得

GET

/staff_stores

サンドボックス
本番

従業員事業所を取得します

対象

プラン
- スタンダード、旧無料
- プレミアム
- プレミアムプラス
- エンタープライズ、旧有料

対象ユーザー権限

従業員管理閲覧（全て）
従業員管理閲覧（給与情報除く）

Authorizations

AppAccessToken
timecard.staffs:read
UserAccessToken
timecard.staffs:read

Parameters

Query Parameters

staff_id

string

従業員ID（事業所IDとのどちらかが必須）

Example

store_id

string

事業所ID（従業員IDとのどちらかが必須）

Example

termination

number

退職者を含めて表示するかどうか

0: 表示しない
1: 表示する

Example

active

number

利用設定

0: 利用しない
1: 利用する

指定しない場合、全てのデータを対象とします。

Example

Responses

200

取得成功

object

staffId

従業員ID

string

storeId

事業所ID

string

storeName

事業所名

string

staffName

従業員名

string

favoriteFlag

事業所からのメールを受信するかどうか

"": 希望しない
1: 希望する

「希望する」を選択した場合、かんたんシフト作成を利用時に送信される事業所からのシフト作成依頼メールを受信します。

string

Allowed values: "" 1

applicationDisplayFlag

アプリ表示設定

0: 表示しない
1: 表示する

スマレジ・タイムカードアプリの打刻する従業員を選択する画面(タイムカード->写真から選択)で表示するかどうかを設定します。

string

Allowed values: 0 1

staff

従業員データリスト

Array<object>

object

staffId

従業員ID

string

staffName

従業員名

string

staffKana

フリガナ

string

staffCode

社員番号

string

initial

イニシャル(カナ1文字)
(アカサタナハマヤラワ A-Z その他)

string

gender

性別

0: 男性
1: 女性
9: 未選択

string

Allowed values: 0 1 9

birthday

生年月日 [YYYY-MM-DD]

string format: date

postCode

郵便番号

string

address

住所

string

phone

電話番号

string

mail

メールアドレス

string

hireDate

入社日 [YYYY-MM-DD]

string format: date

terminationDate

退職日 [YYYY-MM-DD]

string format: date

terminationFlag

退職済みかどうか

0: 未退職
1: 退職済み

string

Allowed values: 0 1

activeFlag

利用可能なユーザーかどうか

0: 利用不可
1: 利用可能

string

Allowed values: 0 1

adminFlag

管理者権限の有無

0: 一般
1: 管理者

string

Allowed values: 0 1

estimateIncome

合計所得見積額（円）

string

foreignerFlag

外国人に該当するかどうか

0: 該当しない
1: 該当する

string

Allowed values: 0 1

handicappedDivision

障害者に該当するかどうか

1: 該当しない
2: 一般障害者
3: 特別障害者

string

Allowed values: 1 2 3

studentFlag

勤労学生に該当するかどうか

0: 該当しない
1: 該当する

string

Allowed values: 0 1

paidHolidayInitialTargetDate

有給休暇付与基準日（通常は入社半年後） [YYYY-MM-DD]

string format: date

displaySequence

表示順

string

employeeClassificationId

従業員区分ID

string

{
  "staffId": "1",
  "storeId": "1",
  "storeName": "スマレジ本社",
  "staffName": "スマレジ太郎",
  "favoriteFlag": "1",
  "applicationDisplayFlag": "1",
  "staff": [
    {
      "staffId": "1",
      "staffName": "スマレジ太郎",
      "staffKana": "スマレジタロウ",
      "staffCode": "A001",
      "initial": "ス",
      "gender": "0",
      "birthday": "1990-04-01",
      "postCode": "111-1111",
      "address": "大阪府大阪市中央区本町",
      "phone": "00-0000-0000",
      "mail": "taro@example.jp",
      "hireDate": "2020-04-01",
      "terminationDate": "",
      "terminationFlag": "0",
      "activeFlag": "1",
      "adminFlag": "1",
      "estimateIncome": "3000000",
      "foreignerFlag": "0",
      "handicappedDivision": "1",
      "studentFlag": "0",
      "paidHolidayInitialTargetDate": "2020-10-01",
      "displaySequence": "1",
      "employeeClassificationId": "1"
    },
    {
      "staffId": "2",
      "staffName": "スマレジ花子",
      "staffKana": "スマレジハナコ",
      "staffCode": "A002",
      "initial": "ス",
      "gender": "1",
      "birthday": "1995-07-15",
      "postCode": "222-222",
      "address": "東京都渋谷区代々木",
      "phone": "06-6949-8902",
      "mail": "hanako@example.jp",
      "hireDate": "2021-04-01",
      "terminationDate": "2025-06-25",
      "terminationFlag": "0",
      "activeFlag": "0",
      "adminFlag": "0",
      "estimateIncome": "2500000",
      "foreignerFlag": "0",
      "handicappedDivision": "1",
      "studentFlag": "0",
      "paidHolidayInitialTargetDate": "2021-10-01",
      "displaySequence": "2",
      "employeeClassificationId": "2"
    }
  ]
}

400

パラメータに誤りがある場合

object

type

エラータイプを識別するURI、もしくはabout:blank

string

title

エラーの概要

string

detail

エラーの詳細

string

Example

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "従業員IDもしくは事業所IDのどちらかが必須です。"
}

404

指定したIDのデータが存在しない場合

object

type

エラータイプを識別するURI、もしくはabout:blank

string

title

エラーの概要

string

detail

エラーの詳細

string

Example

{
  "type": "about:blank",
  "title": "Not Found",
  "detail": "データが確認できませんでした。従業員ID: 999"
}