WorkVellWorkVell
admin-eng·サポートコードENG-028 管理者・担当者向け

WorkVellカスタムフィールドのAPIでの取得

管理者が追加したカスタムフィールドのデータをAPIで取得する方法を説明します。

【カスタムフィールドとは】

Workvellの標準フィールドに加えて、

会社独自の従業員情報項目を追加できる機能(#SETUP-026参照)。

例:「車両ナンバー」「社内資格番号」「部活動」「配偶者の氏名」等

【APIでのカスタムフィールド取得】

カスタムフィールドのデータは従業員APIのレスポンスに含まれます:

エンドポイント:

GET /api/v2/employees/{employee_id}

レスポンス(抜粋):

{
  "id": "emp-xxxx",
  "name": "山田太郎",
  "custom_fields": {
    "vehicle_number": "品川 3 あ 1234",
    "club_activity": "野球部",
    "internal_license_no": "XXX-0001"
  }
}

【カスタムフィールドの一覧取得】

GET /api/v2/custom_fields

→ 会社で設定されているカスタムフィールドの定義一覧を返す

【カスタムフィールドの更新(API)】

PATCH /api/v2/employees/{employeeid}/customfields

→ キー名と値を指定して更新

【注意事項】

カスタムフィールドに個人情報を含む場合は、

APIキーのスコープを必要最小限に設定してください。

カスタムフィールドAPIREST API従業員データ

この記事は役に立ちましたか?

関連ドキュメント

同じカテゴリのドキュメント