HERP Hire APIを通じて、ご利用中の『HERP Hire』内のデータ取得や『HERP Hire』上へのデータ登録・変更が可能になります。
なお、本機能は皆様の採用業務に弊社サービスをより柔軟にご活用いただく（例:独自の採用分析ダッシュボード構築など）ために公開していることから、以下の通りサポート範囲を定めております。
【サポート範囲】
・API仕様
・認証方法に関するご質問
・ドキュメント記載内容の説明
【サポート対象外】
・個別ツールの設計・実装支援
・外部サービスとの連携仕様の策定
・構築後のツール運用サポート、等
面接日程登録や評価の依頼・投稿を自動化
特定の職種×選考ステップでマスタシートを作成し、手動登録の手間とミスを削減。
HERP Hireへの手作業での転記を自動化
外部ツールで取得したアンケート回答などを、『HERP Hire』の応募情報へ自動で登録。
採用データの集計工数を削減
スプレッドシートなどにデータを自動連携し、採用活動に必要な独自の集計を効率化。
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} | 個別応募に評価を記入 | ||
GET /v1/candidacies/{id}/assignments | 個別応募にアサインされてている担当メンバー一覧を取得 | ユーザーID,ユーザーの権限 | |
POST /v1/candidacies/{id}/assignments | 個別応募に対する担当メンバーをアサイン | ||
DELETE /v1/candidacies/{id}/assignments | 個別応募に対する担当メンバーのアサインの解除 | ||
PATCH /v1/candidacies/{id}/termination | 個別応募の選考を終了 |
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と連携し、書類選考の自動化（下記フローイメージ）
|
POST /v1/candidacies | ・連携対象外の媒体からの応募取り込み ・独自の応募フォームからの応募 ・シート管理している説明会参加者からの応募取り込み |
POST /v1/candidacies/{id}/files | ・API経由で応募追加する際に合わせてファイルも追加 ・外部の適性検査やリファレンスチェックの結果の自動格納 |
GET /v1/candidacies/{id}/contacts | ・候補者ごとの選考予定/予定と評価のステータスを一覧化 （※HERPにて テンプレートをご用意しております。利用方法ページをご参考ください） ・評価記入に必要な評価依頼IDの取得 |
POST /v1/candidacies/{id}/contacts | ・特定の職種×選考ステップでマスタシートを作成し、コンタクト作成自動化 （※HERPにて テンプレートをご用意しております。必ず注意事項をご確認の上、利用方法は動画もご確認ください。 2026/1：メンバーアサイン・選考終了機能も追加） ・外部日程調整ツールと連携し、選考予定作成 |
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ワークフローから評価記入 |
GET /v1/candidacies/{id}/assignments | ・該当候補者の情報を閲覧可能なメンバーを確認 |
POST /v1/candidacies/{id}/assignments | ・コンタクト作成時に決まったゲスト権限を自動アサイン （※コンタクト作成自動化テンプレートにて自動アサインも実装しております） （※職種別ゲスト権限機能においては、「自動アサインされたゲスト権限のアサイン解除」や「任意のタイミングでのアサイン」は不可でしたが、本APIをご利用いただくことで「任意のタイミングで職種別の自動アサイン→解除」も可能です） |
DELETE /v1/candidacies/{id}/assignments | ・選考終了のタイミングでゲスト権限のアサイン解除 |
PATCH /v1/candidacies/{id}/termination | ・スプレッドシート上から選考終了 （※コンタクト作成自動化テンプレートにて選考終了も実装しております） ・生成AIと連携し、書類選考不合格の場合は自動で選考終了処理 |
開発者向けのHERP Hire API ドキュメントも公開しております。
以下フォームから設定したい機能を申請ください。設定後、担当から完了の連絡をいたします。
申請後、順次ご提供いたしますが、ご利用希望企業様が多い場合、しばらくお待ちいただく可能性があります。
ご不明点がございましたらお問い合わせください。
HERP Hireの管理者権限のみHERP Hire APIキーの発行ができます
申請フォームより、追加利用規約にご締結いただいた1〜2営業日で、HERP Hire APIキー発行が可能になります
右上のメニューバーよりアクセス
HERP Hire APIキー発行画面にアクセス
名前・有効期限・スコープを入力
コピーアイコンよりAPIキーを取得
APIキー発行画面は閉じると再度表示されないのでご留意ください