従業員利用OFF可否一括事前判定

GET

/staffs/active

• サンドボックス
• 本番

従業員の利用OFF可否を一括で事前判定します。
当月（JST: Asia/Tokyo のカレンダー月）にプラットフォームAPI経由で
打刻・シフト登録・実績登録のいずれかを行なった従業員は利用OFFにすることはできません。

staff_id はカンマ区切りで複数指定できます（最大100件）。 指定値のうち、存在する従業員IDの判定結果のみ返します。

本APIは事前判定用途です。
更新可否の最終判定は「従業員利用ON/OFF更新API」実行時に再評価します。

対象

• プラン
  • スタンダード
  • プレミアム
  • プレミアムプラス
  • エンタープライズ

対象ユーザー権限

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

Authorizations

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

Parameters

Query Parameters

staff_id

required

string

従業員ID（カンマ区切りで複数指定可、最大100件）

Example

1,2,3

Responses

200

取得成功

object

staffs

従業員ごとの利用OFF可否判定結果

Array<object>

object

staffId

従業員ID

string

activeFlag

現在の利用設定

boolean

canDeactivate

利用OFFが可能かどうか

boolean

deactivateBlockReasons

利用OFF不可の理由コード一覧

• MONTHLY_USAGE_EXISTS: 当月中にプラットフォームAPI経由の利用実績がある
• OWNER_STAFF: 契約オーナー従業員である
• SELF_LOGGED_IN: ログイン中の本人である

Array<string>

<= 3 items unique items

Allowed values: MONTHLY_USAGE_EXISTS OWNER_STAFF SELF_LOGGED_IN

currentMonthUsageExists

当月利用実績があるかどうか（プラットフォームAPI実績基準）

boolean

lastPfApiUsageAt

最終利用日時（プラットフォームAPI実績基準）

string format: date-time

nullable

evaluationMonth

判定対象月（YYYY-MM）

string

/^\d{4}-(0[1-9]|1[0-2])$/

evaluatedAt

判定実行日時

string format: date-time

Example

{
  "staffId": "123",
  "activeFlag": true,
  "canDeactivate": false,
  "deactivateBlockReasons": [
    "MONTHLY_USAGE_EXISTS"
  ],
  "currentMonthUsageExists": true,
  "lastPfApiUsageAt": "2026-02-09T12:34:56+09:00",
  "evaluationMonth": "2026-02",
  "evaluatedAt": "2026-02-12T10:00:00+09:00"
}

Example

{
  "staffs": [
    {
      "staffId": "1",
      "activeFlag": true,
      "canDeactivate": false,
      "deactivateBlockReasons": [
        "MONTHLY_USAGE_EXISTS"
      ],
      "currentMonthUsageExists": true,
      "lastPfApiUsageAt": "2026-02-09T12:34:56+09:00",
      "evaluationMonth": "2026-02",
      "evaluatedAt": "2026-02-12T10:00:00+09:00"
    },
    {
      "staffId": "2",
      "activeFlag": true,
      "canDeactivate": true,
      "deactivateBlockReasons": [],
      "currentMonthUsageExists": false,
      "lastPfApiUsageAt": null,
      "evaluationMonth": "2026-02",
      "evaluatedAt": "2026-02-12T10:00:00+09:00"
    }
  ]
}

400

• staff_id が未指定または空文字の場合
• staff_id の指定件数が100件を超える場合

object

type

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

string

title

エラーの概要

string

detail

エラーの詳細

string

Examples

`staff_id` が未指定または空文字の場合

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "`staff_id` は必須です。"
}

`staff_id` の指定件数が100件を超える場合

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "`staff_id` の件数は100件以下で指定してください。"
}