ヘルプセンター
background
SmartHR APIのリリースノート
  1. SmartHRヘルプセンター
  2. リリースノート
  3. SmartHR APIのリリースノート
  4. 2025/06/25 APIリファレンスをAPIの実際のレスポンスに合わせました 他1件

2025/06/25 APIリファレンスをAPIの実際のレスポンスに合わせました 他1件

2025年6月25日(水)に行なったアップデートの詳細をお知らせします。

SmartHR APIの変更点は、改善1件・不具合修正1件でした。

📈 改善

APIリファレンスをAPIの実際のレスポンスに合わせました

下記のAPIエンドポイントのAPIリファレンス(ドキュメント)をAPIの実際のレスポンスに合わせました。

  • GET /v1/crews(従業員リストの取得)
  • GET /v1/crews/{id}(従業員取得)
  • GET /v1/crew_custom_field_template_groups(カスタム従業員項目グループリストの取得)
  • GET /v1/crew_custom_field_template_groups/{id}(カスタム従業員項目グループ取得)
  • GET /v1/crew_custom_field_templates(カスタム従業員項目テンプレートリストの取得)
  • GET /v1/crew_custom_field_templates/{id}(カスタム従業員項目テンプレート取得)
  • GET /v1/departments(部署リストの取得)
  • GET /v1/departments/{id}(部署取得)

これまで、これらのAPIエンドポイントでは、実際に返されるレスポンスの項目と、APIリファレンスに記載されている仕様の内容が一致していませんでした。

この問題により、APIリファレンスを参考にしてアプリケーション開発する際に、想定したレスポンスと異なる項目が返される状況が発生していました。

これらのAPIエンドポイントのレスポンスで、APIリファレンスと乖離していた項目を修正しました。 これにより、APIリファレンスの記載内容に基づいてアプリケーション開発を行なえるようになりました。

変更後のレスポンスについては、SmartHR API ドキュメント別タブで開くを参照してください。

👨‍⚕️ 不具合修正

  • 従業員情報申請機能で適用日を含む申請が承認され、現在時点の従業員情報が更新される場合でも、以下APIのupdated_at(最終更新日)が更新されない不具合を修正しました。
    • 従業員リストの取得API(/v1/crews)
    • 従業員の取得API(/v1/crews/{id})