従業員一覧取得

GET

/staffs

サンドボックス
本番

従業員一覧を取得します

対象

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

対象ユーザー権限

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

Authorizations

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

Parameters

Query Parameters

store_id

string

>= 1

事業所ID（1以上の整数で指定、カンマ区切りで複数指定可）

Example

staff_name

string

従業員名

Example

スマレジ太郎

termination

number

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

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

Example

staff_group_code

string

従業員グループコード
カンマ区切りで複数指定可能

Example

1,2

active

number

利用設定

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

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

Example

limit

integer

default: 30 >= 1 <= 100

上限値

Example

page

integer

default: 1 >= 1

検索対象ページ番号

Example

sort

string

ソート順
パラメータ名で昇順、パラメータ名:descで降順指定可カンマ区切りで複数項目指定可
以下の項目でソートが可能です。

staff_id
staff_name
hire_date
staff_code
is_active

Example

?sort=staff_id%2Chire_date%3Adesc

Responses

200

取得成功

object

count

件数

number

page

現在のページ番号

number

pageCount

総ページ数

number

staffs

従業員一覧

Array<object>

unique items

object

staffId

従業員ID

string

staffGroupCode

従業員グループコード（カンマ区切り）

string

staffName

従業員名

string

>= 1 characters <= 50 characters

staffKana

フリガナ

string

>= 1 characters <= 50 characters

staffCode

社員番号

string

0 <= 255 characters

initial

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

string

>= 1 characters <= 1 characters

gender

性別

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

string

Allowed values: 0 1 9

birthday

生年月日 [YYYY-MM-DD]

string

postCode

郵便番号

string

0 <= 10 characters

address

住所

string

0 <= 200 characters

phone

電話番号

string

0 <= 20 characters

mail

メールアドレス

string

0 <= 255 characters

hireDate

入社日 [YYYY-MM-DD]

string

terminationDate

退職日 [YYYY-MM-DD]

string

termination

退職済みかどうか

0: 未退職
1: 退職済み

string

Allowed values: 0 1

terminationReason

退職事由（労働者名簿の必須記載事項）

string

0 <= 100 characters

retirementIncome

退職所得（円）

integer

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

displaySequence

表示順

string

employeeClassificationId

従業員区分ID

string

dashboardType

ログイン直後の画面

0: 従業員トップ
1: 管理者トップ

integer

Allowed values: 0 1

roleInEmployeeList

従事する業務の種類

string

0 <= 100 characters

householdHeaderName

世帯主

string

0 <= 32 characters

householdHeaderRelationship

世帯主との続柄

0: 本人
1: 配偶者
2: 息子
3: 娘
4: 父
5: 母
6: 兄
7: 姉
8: 弟
9: 妹
10: 祖父
11: 祖母
12: 孫
13: 義父
14: 義母
99: その他

integer

nullable

Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 99

spouseFlag

配偶者の有無

boolean

widowDivision

(旧)寡婦/寡夫 2019年以前の源泉徴収票の登録項目

1: 該当しない
2: 一般の寡婦
3: 特別の寡婦
4: 寡夫

integer

Allowed values: 1 2 3 4

widowDivision2

寡婦/ひとり親 2020年以降の源泉徴収票の登録項目

1: 該当しない
2: 寡婦
3: ひとり親

integer

Allowed values: 1 2 3

passCode

出退勤パスコード数字4桁

string

nullable >= 4 characters <= 4 characters

stampScreenDisplayFlag

出退勤画面への表示フラグ

boolean

personalWebStampScreenDisplayFlag

個別WEB出退勤画面表示フラグ

boolean

personalWebStatementScreenDisplayFlag

給与明細個別表示フラグ

boolean

maximumAnnualSalary

年収目安（円）

integer

nullable

Example

{
  "count": 2,
  "page": 1,
  "pageCount": 1,
  "staffs": [
    {
      "staffId": "1",
      "staffGroupCode": "1,2",
      "staffName": "スマレジ太郎",
      "staffKana": "スマレジタロウ",
      "staffCode": "EMP001",
      "initial": "ス",
      "gender": "0",
      "birthday": "1990-01-01",
      "postCode": "111-1111",
      "address": "大阪府大阪市中央区本町",
      "phone": "00-0000-0000",
      "mail": "taro@example.jp",
      "hireDate": "2020-01-01",
      "terminationDate": "",
      "termination": "0",
      "terminationReason": "",
      "retirementIncome": 0,
      "activeFlag": "1",
      "adminFlag": "1",
      "estimateIncome": "3000000",
      "foreignerFlag": "0",
      "handicappedDivision": "1",
      "studentFlag": "0",
      "paidHolidayInitialTargetDate": "2020-07-01",
      "displaySequence": "1",
      "employeeClassificationId": "1",
      "dashboardType": 1,
      "roleInEmployeeList": "経理",
      "householdHeaderName": "スマレジ太郎",
      "householdHeaderRelationship": 0,
      "spouseFlag": true,
      "widowDivision": 1,
      "widowDivision2": 1,
      "passCode": "1234",
      "stampScreenDisplayFlag": true,
      "personalWebStampScreenDisplayFlag": true,
      "personalWebStatementScreenDisplayFlag": true,
      "maximumAnnualSalary": 4000000
    },
    {
      "staffId": "2",
      "staffGroupCode": "2",
      "staffName": "スマレジ花子",
      "staffKana": "スマレジハナコ",
      "staffCode": "EMP002",
      "initial": "ス",
      "gender": "1",
      "birthday": "1995-03-15",
      "postCode": "222-2222",
      "address": "東京都渋谷区代々木",
      "phone": "00-0000-0000",
      "mail": "hanako@example.jp",
      "hireDate": "2021-04-01",
      "terminationDate": "2025-06-25",
      "termination": "0",
      "terminationReason": "家庭の事情",
      "retirementIncome": 0,
      "activeFlag": "1",
      "adminFlag": "0",
      "estimateIncome": "2500000",
      "foreignerFlag": "0",
      "handicappedDivision": "1",
      "studentFlag": "0",
      "paidHolidayInitialTargetDate": "2021-10-01",
      "displaySequence": "2",
      "employeeClassificationId": "2",
      "dashboardType": 0,
      "roleInEmployeeList": "営業",
      "householdHeaderName": "スマレジ花子",
      "householdHeaderRelationship": 0,
      "spouseFlag": false,
      "widowDivision": 1,
      "widowDivision2": 1,
      "passCode": "5678",
      "stampScreenDisplayFlag": true,
      "personalWebStampScreenDisplayFlag": true,
      "personalWebStatementScreenDisplayFlag": true,
      "maximumAnnualSalary": 3000000
    }
  ]
}

Headers

Link

string

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

400

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

object

type

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

string

title

エラーの概要

string

detail

エラーの詳細

string

Example

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "退職者の指定は0か1で行なってください"
}