> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 概要

> 勤怠オープン API の概要ページ。勤怠グループ、シフト、打刻、休暇管理など主要 API を一覧で確認できます。

このトピックでは、勤怠オープン API の機能と連携方法を説明します。

## 勤怠とは

勤怠は、組織向けに社員の勤怠管理ソリューションを提供する DingTalk の公式アプリです。チームの状況をいつでもどこでも確認できます。**誰が出勤しているかがひと目でわかり**、手作業で確認しなくても**勤怠データを自動で集計します**。詳しくは、[勤怠管理者向けクイックスタート](https://help.dingtalk.io/ja/attendance/admin-quick-start.md)を参照してください。

主な機能：

* **多様な勤怠シーンに対応する複数の打刻方法**：GPS 位置情報や Wi-Fi などで打刻できます。
* **社内勤務と外勤を一元管理し、集計を効率化**：外勤打刻により、一時的に外出している社員や出張中の社員の勤怠を記録できます。
* **休暇・勤怠承認と連携し、勤怠統計を 1 つの表に集約**：休暇、残業、外出、出張の承認が自動で集計・計算されるため、複数のレポートを照合する必要がありません。

## 勤怠を有効にする方法

勤怠は、DingTalk にデフォルトでインストールされている公式アプリです。社員は DingTalk のワークベンチから開いて利用します。

* モバイル：DingTalk モバイルクライアント > ワークベンチ

  DingTalk モバイルクライアントで、次の操作を行います。

  1. 下部のナビゲーションバーで **ワークベンチ** をタップします。
  2. **勤怠** アプリを開きます。
* デスクトップ：DingTalk デスクトップクライアント > ワークベンチ

  DingTalk クライアントで **ワークベンチ** を開きます。**全社員** セクションで **勤怠** アプリを選択し、設定を開始します。

## オープン機能の概要

### API 一覧

勤怠では、豊富なオープン API を提供しています。これらの API を使用して、勤怠と社内の業務システムを連携できます。

#### 勤怠グループ管理

| **API** | **API 説明** | **API バージョン** |
| - | - | - |
| [勤怠グループの作成](https://help.dingtalk.io/ja/open/development/attendance-group-write.md) | この API を呼び出して、勤怠グループを作成します。 | 旧バージョン |
| [勤怠グループの更新](https://help.dingtalk.io/ja/open/development/attendance-group-update-interface.md) | この API を呼び出して、勤怠グループ ID を指定して勤怠グループ情報を更新します。 | 旧バージョン |
| [勤怠グループの削除](https://help.dingtalk.io/ja/open/development/delete-attendance-group.md) | この API を呼び出して、勤怠グループを一括削除します。 | 旧バージョン |
| [勤怠グループ概要の検索](https://help.dingtalk.io/ja/open/development/attendance-group-search.md) | この API を呼び出して、名前で勤怠グループをあいまい検索し、概要情報を取得します。 | 旧バージョン |
| [勤怠グループ詳細の取得](https://help.dingtalk.io/ja/open/development/query-a-single-attendance-group.md) | この API を呼び出して、勤怠グループ ID を指定して勤怠グループの詳細を取得します。 | 旧バージョン |
| [groupKey による勤怠グループ情報の照会](https://help.dingtalk.io/ja/open/development/queries-attendance-group-information-by-id.md) | この API を呼び出して、勤怠グループ ID を指定して勤怠グループ情報を照会します。 | 旧バージョン |
| [groupKey から groupId への変換](https://help.dingtalk.io/ja/open/development/convert-groupkey-to-groupid.md) | この API を呼び出して、勤怠グループの groupKey を groupId に変換します。 | 旧バージョン |
| [groupId から groupKey への変換](https://help.dingtalk.io/ja/open/development/groupid-to-groupkey.md) | この API を呼び出して、勤怠グループの groupId を groupKey に変換します。 | 旧バージョン |
| [勤怠グループ概要の一括取得](https://help.dingtalk.io/ja/open/development/batch-query-of-simple-information-of-the-attendance-group.md) | この API を呼び出して、社内のすべての勤怠グループの概要情報をページ単位で取得します。 | 旧バージョン |
| [勤怠グループ詳細の一括取得](https://help.dingtalk.io/ja/open/development/batch-obtain-attendance-group-details.md) | この API を呼び出して、すべての勤怠グループの詳細を照会します。 | 旧バージョン |
| [ユーザーの勤怠グループの取得](https://help.dingtalk.io/ja/open/development/queries-a-user-attendance-group.md) | この API を呼び出して、社員の勤怠グループ情報を取得します。 | 旧バージョン |
| [勤怠対象者の一括追加](https://help.dingtalk.io/ja/open/development/batch-add-employees-under-the-attendance-group.md) | この API を呼び出して、指定した勤怠グループにメンバーを一括追加します。 | 旧バージョン |
| [勤怠対象者の更新](https://help.dingtalk.io/ja/open/development/attendance-group-member-update.md) | この API を呼び出して、勤怠グループのメンバーを更新します。ユーザー、部門、勤怠対象外メンバーを追加または削除できます。 | 旧バージョン |
| [勤怠対象者の取得](https://help.dingtalk.io/ja/open/development/batch-query-of-attendance-group-members.md) | この API を呼び出して、操作者のユーザー ID と勤怠グループ ID を指定して勤怠グループのメンバーを取得します。 | 旧バージョン |
| [勤怠対象者のユーザー ID の取得](https://help.dingtalk.io/ja/open/development/query-attendance-group-personnel-information-in-batches.md) | この API を呼び出して、勤怠グループ内の全社員のユーザー ID をページ単位で取得します。 | 旧バージョン |
| [勤怠対象者の一括削除](https://help.dingtalk.io/ja/open/development/batch-delete-employees-under-the-attendance-group.md) | この API を呼び出して、指定した勤怠グループからメンバーを一括削除します。 | 旧バージョン |
| [勤怠対象者一覧の照会](https://help.dingtalk.io/ja/open/development/batch-query-of-employees-in-the-attendance-group.md) | この API を呼び出して、指定した勤怠グループの社員一覧を照会します。 | 旧バージョン |
| [ユーザーが勤怠グループに所属しているかの確認](https://help.dingtalk.io/ja/open/development/query-members-by-id.md) | この API を呼び出して、部門または社員が勤怠グループに所属しているかを確認します。勤怠グループに所属する部門または社員の ID が返されます。 | 旧バージョン |
| [Wi-Fi 情報の一括追加](https://help.dingtalk.io/ja/open/development/batch-add-wifi-under-attendance-group.md) | この API を呼び出して、指定した勤怠グループに Wi-Fi 情報を一括追加します。 | 旧バージョン |
| [Wi-Fi 情報の一括照会](https://help.dingtalk.io/ja/open/development/batch-query-wifi-under-attendance-group.md) | この API を呼び出して、指定した勤怠グループの Wi-Fi 一覧を一括照会します。 | 旧バージョン |
| [Wi-Fi 情報の一括削除](https://help.dingtalk.io/ja/open/development/batch-remove-wifi-under-attendance-group.md) | この API を呼び出して、指定した勤怠グループから Wi-Fi 情報を一括削除します。 | 旧バージョン |
| [打刻場所の一括追加](https://help.dingtalk.io/ja/open/development/atch-add-position-under-attendance-group.md) | この API を呼び出して、指定した勤怠グループに打刻場所（位置情報）を一括追加します。 | 旧バージョン |
| [打刻場所の一括照会](https://help.dingtalk.io/ja/open/development/batch-query-position-under-attendance-group.md) | この API を呼び出して、指定した勤怠グループの打刻場所（位置情報）一覧を一括照会します。 | 旧バージョン |
| [打刻場所の一括削除](https://help.dingtalk.io/ja/open/development/delete-position-in-batches-under-the-attendance-group.md) | この API を呼び出して、指定した勤怠グループから打刻場所（位置情報）を一括削除します。 | 旧バージョン |
| [勤怠の書き込み権限の照会](https://help.dingtalk.io/ja/open/development/attendance-writing-operation-is-brand-new-query.md) | 勤怠グループ内での社員の操作権限を照会します。 | 新バージョン |

#### 勤怠打刻

| **API** | **API 説明** | **API バージョン** |
| - | - | - |
| [打刻結果の取得](https://help.dingtalk.io/ja/open/development/open-attendance-clock-in-data.md) | この API を呼び出して、社内の社員の実際の打刻結果を取得します。 | 旧バージョン |
| [打刻詳細の取得](https://help.dingtalk.io/ja/open/development/attendance-clock-in-record-is-open.md) | この API を呼び出して、社内の社員の実際の打刻詳細を取得します。 | 旧バージョン |
| [打刻記録のアップロード](https://help.dingtalk.io/ja/open/development/upload-punch-records.md) | この API を呼び出して、サードパーティの勤怠システムで記録されたカード打刻や顔認証の記録を、DingTalk の打刻記録として DingTalk 勤怠にアップロードします。 | 新バージョン |

#### 勤怠シフト

| **API** | **API 説明** | **API バージョン** |
| - | - | - |
| [シフトの作成](https://help.dingtalk.io/ja/open/development/create-modify-shifts.md) | この API を呼び出して、DingTalk 勤怠のシフトを作成します。 | 旧バージョン |
| [シフトの削除](https://help.dingtalk.io/ja/open/development/delete-shift.md) | この API を呼び出して、シフト ID を指定して勤怠シフトを削除します。 | 旧バージョン |
| [名前によるシフトの検索](https://help.dingtalk.io/ja/open/development/search-shifts-by-rank.md) | この API を呼び出して、名前でシフトをあいまい検索します。シフト名とシフト ID が返されます。 | 旧バージョン |
| [シフト概要の取得](https://help.dingtalk.io/ja/open/development/enterprise-shift-query-in-batches.md) | この API を呼び出して、すべてのシフトの情報を照会します。 | 旧バージョン |
| [シフト詳細の取得](https://help.dingtalk.io/ja/open/development/shift-query.md) | この API を呼び出して、シフト ID を指定してシフトの詳細を照会します。 | 旧バージョン |
| [過去のシフトの照会](https://help.dingtalk.io/ja/open/development/query-history-shifts.md) | この API を呼び出して、シフト ID とバージョンを指定して過去のシフトを照会します。 | 旧バージョン |
| [打刻時間帯の設定変更](https://help.dingtalk.io/ja/open/development/modify-card-settings.md) | この API を呼び出して、勤怠シフトの打刻ポイントの設定を変更します。 | 旧バージョン |

#### 勤怠シフト設定

| **API** | **API 説明** | **API バージョン** |
| - | - | - |
| [ユーザーのシフト設定情報の照会](https://help.dingtalk.io/ja/open/development/query-scheduling-for-a-day.md) | この API を呼び出して、特定の勤務日におけるユーザーのシフト設定情報を照会します。 | 旧バージョン |
| [ユーザーのシフト設定情報の一括照会](https://help.dingtalk.io/ja/open/development/query-batch-scheduling-information.md) | この API を呼び出して、勤務日における社員のシフト設定情報を一括照会します。 | 旧バージョン |
| [シフト制勤怠グループのシフト設定](https://help.dingtalk.io/ja/open/development/scheduling-system-attendance-group-scheduling.md) | この API を呼び出して、シフト制勤怠グループのメンバーにシフトを設定します。 | 旧バージョン |
| [シフト設定の打刻結果の照会](https://help.dingtalk.io/ja/open/development/query-the-results-of-a-batch-of-tasks.md) | この API を呼び出して、設定されたシフトの打刻結果を照会します。結果には、打刻時刻、遅刻、早退、社内勤務、外勤の情報が含まれます。 | 旧バージョン |
| [組織の勤怠シフト設定詳細の照会](https://help.dingtalk.io/ja/open/development/interface-for-daily-full-query-of-attendance-scheduling-information.md) | この API を呼び出して、特定の日の勤怠シフト設定情報を照会します。 | 旧バージョン |
| [ユーザーのシフト設定概要の一括照会](https://help.dingtalk.io/ja/open/development/query-scheduling-summary-information.md) | この API を呼び出して、指定した期間内のユーザーのシフト設定概要を照会します。 | 旧バージョン |

#### 勤怠ルール

| **API** | **API 説明** | **API バージョン** |
| - | - | - |
| [残業ルールのページ単位取得](https://help.dingtalk.io/ja/open/development/retrieve-a-list-of-overtime-rules-by-page.md) | この API を呼び出して、勤怠で設定されている残業ルールの一覧をページ単位で取得します。 | 新バージョン |
| [打刻修正ルールのページ単位取得](https://help.dingtalk.io/ja/open/development/retrieve-a-list-of-replenishment-rules-by-page.md) | この API を呼び出して、勤怠で設定されている打刻修正ルールの一覧をページ単位で取得します。 | 新バージョン |
| [残業ルール設定の一括取得](https://help.dingtalk.io/ja/open/development/batch-retrieve-overtime-rules.md) | この API を呼び出して、残業ルール ID を指定して複数の残業ルールの設定詳細を一括取得します。 | 新バージョン |

#### 勤怠統計

| **API** | **API 説明** | **API バージョン** |
| - | - | - |
| [スマート統計レポートが有効かどうかの確認](https://help.dingtalk.io/ja/open/development/determine-whether-to-enable-attendance-intelligent-report.md) | この API を呼び出して、社内でスマート勤怠レポートが有効になっているかを確認します。スマートレポートが無効の場合、その他の統計レポート API は利用できません。 | 旧バージョン |
| [ユーザーの勤怠データの取得](https://help.dingtalk.io/ja/open/development/obtain-the-attendance-update-data.md) | この API を呼び出して、指定したユーザーの当日の勤怠データ（打刻記録、打刻結果、承認一覧など）を取得します。 | 旧バージョン |
| [レポートからの休暇データの取得](https://help.dingtalk.io/ja/open/development/obtains-the-holiday-data-from-the-smart-attendance-report.md) | この API を呼び出して、休暇名とユーザー ID を指定して DingTalk スマート勤怠レポートから休暇データを取得します。 | 旧バージョン |
| [勤怠レポート列定義の取得](https://help.dingtalk.io/ja/open/development/queries-the-enterprise-attendance-report-column.md) | この API を呼び出して、社内のスマート勤怠レポートの列情報を取得します。 | 旧バージョン |
| [勤怠レポート列の値の取得](https://help.dingtalk.io/ja/open/development/queries-the-column-value-of-the-attendance-report.md) | この API を呼び出して、DingTalk スマート勤怠レポートの列の値を取得します。 | 旧バージョン |

#### 休暇承認

| **API** | **API 説明** | **API バージョン** |
| - | - | - |
| [承認完了の通知](https://help.dingtalk.io/ja/open/development/api-processapprovefinish.md) | この API を呼び出して、承認が完了したことを勤怠に通知します。残業、休暇、外出、出張の各タイプに対応しています。 | 旧バージョン |
| [承認取り消しの通知](https://help.dingtalk.io/ja/open/development/notify-the-attendance-to-modify-the-punch-result-when-the.md) | この API を呼び出して、承認が取り消されたことを勤怠に通知します。残業、休暇、外出、出張、打刻修正の各タイプに対応しています。 | 旧バージョン |
| [打刻修正承認の通知](https://help.dingtalk.io/ja/open/development/make-up-the-card-after-approval.md) | この API を呼び出して、打刻修正が承認されたことを勤怠に通知します。 | 旧バージョン |
| [シフト交換承認の通知](https://help.dingtalk.io/ja/open/development/shift-change-operation-after-approval.md) | シフト交換が承認された後、この API を呼び出して勤怠にシフト交換の実行を通知します。社員は自身のシフト同士、または他の社員とシフトを交換できます。 | 旧バージョン |
| [時間の事前計算](https://help.dingtalk.io/ja/open/development/api-calculateduration.md) | この API を呼び出して、勤怠のシフト設定に基づき、社員の残業、出張、休暇の時間を事前に計算します。 | 旧バージョン |
| [休暇時間の計算](https://help.dingtalk.io/ja/open/development/calculate-leave-duration.md) | この API を呼び出して、シフト設定ルールに基づき自動計算された各社員の休暇時間を取得します。 | 旧バージョン |
| [休暇状況の照会](https://help.dingtalk.io/ja/open/development/query-status.md) | この API を呼び出して、指定した組織の指定したユーザーについて、指定した期間内の休暇状況を照会します。 | 旧バージョン |

#### 休暇管理

| **API** | **API 説明** | **API バージョン** |
| - | - | - |
| [休暇ルールの追加](https://help.dingtalk.io/ja/open/development/add-holiday-rules.md) | この API を呼び出して、休暇ルールを作成します。 | 新バージョン |
| [休暇ルールの更新](https://help.dingtalk.io/ja/open/development/update-holiday-rules.md) | この API を呼び出して、指定した休暇タイプのルールを更新します。 | 新バージョン |
| [休暇ルールの削除](https://help.dingtalk.io/ja/open/development/api-for-deleting-holiday-types.md) | この API を呼び出して、指定した休暇ルールを削除します。 | 旧バージョン |
| [休暇ルール一覧の照会](https://help.dingtalk.io/ja/open/development/holiday-type-query.md) | この API を呼び出して、社内の休暇ルール一覧を照会します。 | 旧バージョン |
| [休暇残数の初期化](https://help.dingtalk.io/ja/open/development/initialize-holiday-balance.md) | この API を呼び出して、休暇残数を一括で初期化します。 | 旧バージョン |
| [休暇残数の照会](https://help.dingtalk.io/ja/open/development/query-holiday-balance.md) | この API を呼び出して、組織単位または社員単位で休暇残数の情報をページ単位で取得します。1 回の呼び出しで 50 件が返されます。 | 旧バージョン |
| [休暇残数の一括更新](https://help.dingtalk.io/ja/open/development/bulk-update-holiday-balance.md) | この API を呼び出して、休暇残数の情報を一括更新します。 | 旧バージョン |
| [社員の休暇残数変更履歴の一括照会](https://help.dingtalk.io/ja/open/development/batch-query-employee-leave-balance-change-record.md) | この API を呼び出して、社員単位で休暇残数の記録をページ単位で取得します。 | 旧バージョン |
| [ユーザーの勤怠休暇情報の照会](https://help.dingtalk.io/ja/open/development/obtain-user-attendance-and-holiday-information.md) | この API を呼び出して、指定期間内の社員の休暇情報を照会します。 | 新バージョン |

### コールバックイベント一覧

勤怠では、シフト変更、勤怠グループ変更、社員の打刻イベント、社員の残業イベントなど、複数のコールバックイベントをサポートしています。その他のイベントについては、イベントサブスクリプションの概要を参照してください。

## 連携ソリューション

社内システムにさらに多くの勤怠機能を組み込むには、次のソリューションを参照してください。

* [勤怠データの可視化：リアルタイムの出勤状況モニタリングと異常アラート](https://help.dingtalk.io/ja/open/development/the-enterprise-big-screen-displays-the-attendance-of-employees.md)
* [打刻修正の自動同期：承認後に DingTalk 勤怠のステータスをリアルタイムで更新](https://help.dingtalk.io/ja/open/development/the-replenishment-card-of-enterprise-self-developed-attendance-system-is-synchronized.md)
* [勤怠ルールの設定：勤怠グループの一括作成と柔軟な調整](https://help.dingtalk.io/ja/open/development/operation-related-to-attendance-group.md)
* [勤怠対象者の割り当て：メンバーの一括登録と精緻な管理](https://help.dingtalk.io/ja/open/development/attendance-group-member-operations.md)
* [日次勤怠レポート：日次統計と多角的なデータ分析](https://help.dingtalk.io/ja/open/development/obtain-the-employee-attendance-report-information.md)
* [打刻データの同期：ハードウェアの打刻記録を DingTalk に自動アップロード](https://help.dingtalk.io/ja/open/development/enterprise-s-own-oa-approval-system-synchronized-to-dingtalk-during-holidays.md)
* [休暇・勤怠承認の連携：休暇・勤怠データを DingTalk 勤怠に自動同期](https://help.dingtalk.io/ja/open/development/attendance-synchronizes-information.md)

## 用語集

### 勤怠グループ

勤怠グループとは、組織管理者が社員向けに設定する勤怠ルールのまとまりです。社内の職種に応じて、異なるタイプの勤怠グループを作成できます。

> [!NOTE]
>
> 旧バージョンと新バージョンの API 仕様の違いにより、勤怠グループは group\_id または groupKey のいずれかで一意に識別されます。groupKey の値を対応する group\_id に変換するには、[groupKey から groupId への変換](https://help.dingtalk.io/ja/open/development/convert-groupkey-to-groupid.md) API を呼び出してください。

勤怠グループには次の 3 種類があります。

* **固定シフト制勤怠グループ**：毎日 9:00〜18:00 勤務で週末が固定休みなど、勤務時間と休日が固定されている社員向けです。
* **シフト制勤怠グループ**：早番・遅番がある社員、日ごとにシフトが異なる社員、休日をシフトで設定する必要がある社員向けです。
* **フレックスタイム勤怠グループ**：勤務時間が柔軟な社員向けです。

[DingTalk 管理コンソール](https://oa.dingtalk.io/?lang=ja_JP)にログインし、**ワークベンチ > アプリ管理 > 勤怠 > 勤怠グループ管理** に移動して勤怠グループを追加します。

### 休暇ルール（leave\_code）

休暇ルールは leave\_code で一意に識別されます。

DingTalk 管理コンソールで **休暇管理** > **休暇ルール** に移動すると、休暇ルールを表示・設定できます。**休暇を追加** をクリックして休暇ルールを作成します。各休暇ルールには次の属性があります。

| フィールド | 説明 |
| - | - |
| 休暇名 | 休暇タイプの名前（例：私用休暇、代休、病気休暇、年次有給休暇、産前産後休暇、配偶者出産休暇、結婚休暇） |
| 休暇単位 | 申請の最小単位：時間単位、半日単位、または日単位 |
| 時間の計算方法 | 休暇時間のカウント方法（例：勤務日ベース） |
| 有給 | 有給休暇か無給休暇か |
| 残数ルール | 残数の上限（例：残数無制限） |
| スコープ | ルールの適用対象（例：組織全体） |
| 操作 | ルールの編集または削除 |

### シフト

勤怠グループを作成する際にシフトを紐付けます。シフトでは、勤怠グループ内の社員の打刻時刻と労働時間を定義します。柔軟な打刻、遅く出勤した場合の遅い退勤、早く出勤した場合の早い退勤、遅刻、欠勤の設定など、社内のニーズに合わせて勤怠シフトをカスタマイズできます。

[DingTalk 管理コンソール](https://oa.dingtalk.io/?lang=ja_JP)にログインし、**アプリ管理 > 勤怠 > シフト管理** に移動してシフトを追加します。

**シフト管理** ページで **シフトを追加** をクリックすると、新しいシフトを作成できます。既存のシフトは次の列で一覧表示されます。

| 列 | 説明 |
| - | - |
| **シフト名** | シフトの名前（例：デフォルトシフト） |
| **勤務時間** | 勤務時間帯（例：09:00〜18:00） |
| **操作** | シフトの **編集** または **削除** |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.