[人事労務API] 事務担当者廃止に伴う変更のお知らせ

■ 概要

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

ログインユーザの取得時に返却されるroleの値からclerkが削除されます。

■ 変更内容

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

変更対象API：freee人事労務 API

変更種別：Breaking Change

変更内容：

 – ログインユーザのGET時に、roleが返却されますが、その中のclerkという返却値が変更されます。今後、事務担当者権限のユーザがこの値を取得する際はカスタム権限としての値「custom-XX (※XX部分はランダムに変動する値)」になります。

変更理由：権限を自由に作成できるカスタム権限機能のリリースに伴い、事務担当者権限はプリセットの権限から、カスタム権限の一つに変更となります。それに伴い、本APIでの返却値もカスタム権限の値に変更します。

■ 変更スケジュール

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

アナウンス日：2025/04/23

変更リリース予定日：2025年05月～07月

■ 対応方法

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

なし

■ 変更後のAPI仕様

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

エンドポイント: /api/v1/users/me

リクエスト: GET

事務担当者の成功時のレスポンスの内容が変化します。role が clerk から custom- で始まるランダムな文字列となります。

レスポンスの具体例を示します。

変更前:

{
  "id": 1,
  "companies": [
    {
      "id": 100,
      "name": "株式会社フリー",
      "role": "clerk",
      "external_cid": "000-000-000",
      "employee_id": 10,
      "display_name": "フリー太郎"
    }
  ]
}

変更後:

{
  "id": 1,
  "companies": [
    {
      "id": 100,
      "name": "株式会社フリー",
      "role": "custom-01HFEC7P2ZMHBERZRBJ3HBBW2E-01JNZ0QKYH6ASRY468GNRMBV6C",
      "external_cid": "000-000-000",
      "employee_id": 10,
      "display_name": "フリー太郎"
    }
  ]
}