HERP Hire API β版

対象プラン：有料プラン

追加料金の有無：無し

設定方法：フォーム申請（※申請フォームはこちら）

ご依頼から設定に要する時間（目安）：申請後、順次ご提供

※ご利用希望企業様が多い場合、しばらくお待ちいただく可能性があります。

HERP Hire API β版でできること

HERP Hire APIを通じて、ご利用中の『HERP Hire』内のデータ取得や『HERP Hire』上へのデータ登録・変更が可能になります。

ご利用イメージ

面接日程登録や評価の依頼・投稿を自動化

特定の職種×選考ステップでマスタシートを作成し、手動登録の手間とミスを削減。

HERP Hireへの手作業での転記を自動化

外部ツールで取得したアンケート回答などを、『HERP Hire』の応募情報へ自動で登録。

採用データの集計工数を削減

スプレッドシートなどにデータを自動連携し、採用活動に必要な独自の集計をを効率化。

※現在17のAPIを提供しておりますが、今後その範囲は順次拡張予定です。

提供しているHERP Hire API

提供一覧

HERP Hire API名	できること	含まれる情報	パラメーター
GET /v1/candidacies	応募の一覧を取得	応募ID,名前,ステータス,職種ID,応募日時,選考ステップ,選考ステップ更新日時,メールアドレス,年齢,現所属,応募経路,最終学歴,経歴,メモ,選考終了理由,選考終了日時,オペレーション担当のユーザID,更新日時	ステータス,応募日,更新日,職種ID,選考ステップ
GET /v1/candidacies/{id}	個別応募の詳細を取得	応募ID,名前,ステータス,職種ID,応募日時,選考ステップ,メールアドレス,年齢,現所属,応募経路,最終学歴,経歴,メモ,オペレーション担当のユーザID,更新日時,関連リンク一覧,エージェントからの推薦コメント,応募者から企業へのメッセージ,選考終了理由,選考終了日時
GET /v1/candidacies/{id}/files	個別応募のファイルのメタデータ一覧を取得	ファイルID,応募ID，ファイル種別,ファイルのMIMEタイプ,ファイルサイズ,ファイル名,アップロード日時,プライベート設定可否
GET /v1/candidacies/{id}/files/{file iD}	個別応募のファイルのバイナリデータを取得
POST /v1/candidacies	応募を追加
POST /v1/candidacies/{id}/files	個別応募にファイルを追加
GET /v1/candidacies/{id}/contacts	個別応募に紐づくコンタクト一覧を取得	コンタクトID,応募の選考ステップ,コンタクトタイプ名,コンタクトの作成日時,作成したユーザーID,コンタクトに紐づく評価一覧（評価依頼ID,評価のステータス,依頼者のユーザーID,評価者のユーザーID）,コンタクトタイプの予定要否,コンタクトに紐づく予定（予定ID，予定のタイトル,選考予定の詳細,予定の作成日時,予定調整者のユーザーID，参加者のユーザーID一覧,会議URL,予定の種別,日程調整URL,予定の開始時間，予定の終了時間）
POST /v1/candidacies/{id}/contacts	個別応募のコンタクトを作成	・コンタクトの基本情報（コンタクトタイプ,紐づく選考ステップ）・選考予定（予定作成 or 日程提案 or 日程調整）・評価依頼
PATCH /v1/candidacies/{id}/step	個別応募の選考ステップを変更
GET /v1/candidacies/{id}/timeline-comments	個別応募のタイムラインコメントを取得	コメントID,本文,メンション先のユーザーID,コメントのテキスト形式,作成日時,最終更新日時,コメント作成者（ID,名前）
POST /v1/candidacies/{id}/timeline-comments	個別応募にタイムラインコメントを追加
GET /v1/requisition-groups	職種グループの一覧を取得	職種グループID,名前,説明,作成日時,更新日時
GET /v1/requisition-groups/{id}	個別の職種グループを取得	職種グループID,名前,説明,紐づいている職種の一覧（ID,名前,アーカイブ可否）,作成日時,更新日時
GET /v1/requisitions	職種の一覧を取得	職種ID,名前,仕事概要,必須スキル,歓迎スキル,求める人物像,給与,勤務地,雇用形態,勤務条件,試用期間,福利厚生,その他,公開状況,求人ページURL,オペレーション担当のユーザーID,作成日時,更新日時,アーカイブ可否	ステータス,公開状況
GET /v1/users	テナントのユーザ一覧を取得	ユーザーID,名前,メールアドレス,権限,作成日時,更新日時,ステータス	ステータス,権限
GET /v1/evaluations/{evaluationRequestId}	個別応募の評価を取得	評価依頼ID,応募ID,コンタクトID,依頼者のユーザーID,評価者のユーザーID,依頼日時,申し送り,評価のステータス,評価完了日時,編集日時,辞退理由,評価の詳細情報（評価フォームID，評価フォーム名,評価項目ID，評価項目,評価項目についての補足説明,回答必須か,質問の種類,選択肢,回答）
PUT /v1/evaluations/{evaluationRequestId}	個別応募に評価を記入

ユースケース

HERP Hire API名	ユースケース
GET /v1/candidacies	・個社が利用しているBIツール（Looker / Tableau等）が参照しているデータベースに直接データを流し込む・特定期間の更新日/ 選考ステップ変更が滞留している候補者のアラート通知
GET /v1/candidacies/{id}	・候補者情報サマリの作成
GET /v1/candidacies/{id}/files	・ファイル本体をダウンロードするにあたってのID取得・履歴書/職務経歴書のアップロード/削除管理
GET /v1/candidacies/{id}/files/{file iD}	・生成AIと連携し、書類選考の自動化（下記フローイメージ）ファイルのメタデータ→バイナリデータを取得する何かしらの方法でファイルから文字情報を抽出する（一例） n8n, Zapier Google Cloud Functions Daxtra等の読み取り専用サービス Pythonでコードを書く取得した文字情報を生成AIにAPIで連携スプレッドシートに吐き出し or HERP Hireのタイムラインに投稿
POST /v1/candidacies	・連携対象外の媒体からの応募取り込み・独自の応募フォームからの応募・シート管理している説明会参加者からの応募取り込み
POST /v1/candidacies/{id}/files	・API経由で応募追加する際に合わせてファイルも追加・外部の適性検査やリファレンスチェックの結果の自動格納
GET /v1/candidacies/{id}/contacts	・候補者ごとの選考予定/予定と評価のステータスを一覧化（※HERPにてテンプレートをご用意しております。利用方法ページをご参考ください）・評価記入に必要な評価依頼IDの取得
POST /v1/candidacies/{id}/contacts	・特定の職種×選考ステップでマスタシートを作成し、コンタクト作成自動化（※HERPにてテンプレートをご用意しております。必ず注意事項をご確認の上、利用方法は動画もご確認ください）・外部日程調整ツールと連携し、選考予定作成
PATCH /v1/candidacies/{id}/step	・HERP Hire外で管理しているスプレッドシートとのステータス連動
GET /v1/candidacies/{id}/timeline-comments	・候補者状況のサマリ作成・自社コミュニケーションツールへの通知
POST /v1/candidacies/{id}/timeline-comments	・リマインド送信・外部アンケートの自動転記・面接書き起こし議事録の自動転記・媒体への新着メッセージの通知
GET /v1/requisition-groups	・応募の一覧と組み合わせてのBIツール上でのフィルタリング
GET /v1/requisition-groups/{id}	・応募の一覧と組み合わせてのBIツール上でのフィルタリング
GET /v1/requisitions	・自社HPの職種情報の自動更新・スプレッドシートでの職種情報管理
GET /v1/users	・アカウント保有者と社員管理ツールの紐づけ
GET /v1/evaluations/{evaluationRequestId}	・特定の評価回答をもとに生成AIツールを起動・スプレッドシートに評価記入データを連携
PUT /v1/evaluations/{evaluationRequestId}	・スプレッドシートに記載の評価の自動転記（※HERPにてテンプレートをご用意しております。利用方法ページをご参考ください）・slack APIと連携し、slackワークフローから評価記入