Talentio APIドキュメント (1.0.0)

Download OpenAPI specification:Download

APIについて

TalentioではHTTPSを用いたAPIによる候補者情報の取得が可能です。
この機能により任意のフォーマットに整形して候補者情報を管理したり、分析したりすることが可能となります。

アクセストークンの設定

APIを利用するには「グローバル設定」より「API設定」画面を開きます。
ここでアクセストークンを発行することができます。
発行されたトークンは忘れずにメモしておいてください。
ウィンドウを閉じるとトークンを確認することはできません。

アクセス制限

TalentioではAPIアクセスを1時間に1000リクエストまでに制限しています。
APIのレスポンスヘッダーには以下のアクセス情報が付加されます。

X-REMAINING: 992 # 期間内にリクエストできる残りの回数
X-RESET: 1153    # 残り回数がリセットするまでの秒数

認証

リクエストヘッダーに以下のようなアクセストークンを付加してください。

curl -H 'Authorization: Bearer ACCESS_TOKEN' https://talentio.com/api/v1

レスポンスステータス

レスポンスのステータスコードは以下のように解釈されます。

ステータスコード 説明
200 正常なレスポンス
400 パラメーターに不備があった
401 認証に失敗した
429 アクセス回数が制限を超えた
500 サーバー側で予期しないエラーが発生した

Authentication

bearerAuth

Security scheme type: HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

候補者

候補者一覧の取得

Authorizations:
query Parameters
page
integer <int64> >= 1

取得するページ番号を指定します。1ページ内に含まれる候補者数は100です。
取得対象の総数は X-TOTAL ヘッダーで確認することができます。

status
string

候補者のステータスで絞り込みます。初期値は 設定なし です。
その他の設定値は以下の状態を表します。

設定値 状態
ongoing 選考中
reject 辞退
fail 不合格
pass 採用
poolActive コンタクト中
poolInactive 非コンタクト中
sort
string

登録日もしくは応募日でのソートを指定します。

設定値 意味
registeredAt 登録日昇順
-registeredAt 登録日降順
appliedAt 応募日昇順
-appliedAt 応募日降順

Responses

200

正常なレスポンス

400

不正なリクエストです

401

アクセストークンが設定されていないか不正な値です

429

アクセス回数が制限を超えました

500

サーバ側で予期しないエラーが発生しました

get /candidates
https://talentio.com/api/v1/candidates

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

候補者詳細情報の取得

候補者一覧に含まれない、候補者の選考の各評価などの情報を取得することができます。

Authorizations:
path Parameters
candidateId
required
integer <int64>

取得したい候補者の候補者idを設定します

Responses

200

正常なレスポンス

400

不正なリクエストです

401

アクセストークンが設定されていないか不正な値です

429

アクセス回数が制限を超えました

500

サーバ側で予期しないエラーが発生しました

get /candidates/{candidateId}
https://talentio.com/api/v1/candidates/{candidateId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "requisition":
    {
    },
  • "description": "string",
  • "registeredAt": "2019-12-13T08:34:14Z",
  • "appliedAt": "2019-12-13T08:34:14Z",
  • "joinedAt": "2019-12-13T08:34:14Z",
  • "stages":
    [
    ],
  • "status": "ongoing",
  • "channelType": "agent",
  • "channelName": "string",
  • "priority": 0,
  • "tags":
    [
    ],
  • "birthAt": "2019-12-13T08:34:14Z",
  • "customFields":
    [
    ]
}

選考

指定候補者に任意の選考を追加します。

Authorizations:
path Parameters
candidateId
required
integer <int64>

候補者ID

query Parameters
evaluations
required
object (StageEmployee)

評価者を employee キーで指定します。

type
required
string
Enum: "contact" "resume" "interview" "reference" "final"

選考種別を指定します。指定可能な文字列は以下になります。

scheduledAt
string <date-time>

選考日をISO8601形式で設定します。初期値は null です。

description
string

補足を文字列として設定します。初期値は空文字です。

Responses

200

正常なレスポンス

400

不正なリクエストです

401

アクセストークンが設定されていないか不正な値です

429

アクセス回数が制限を超えました

500

サーバ側で予期しないエラーが発生しました

post /candidates/{candidateId}/stages
https://talentio.com/api/v1/candidates/{candidateId}/stages

コメント

指定候補者へのコメント一覧を取得します。

Authorizations:
path Parameters
candidateId
required
integer <int64>

候補者ID

Responses

200

正常なレスポンス

400

不正なリクエストです

401

アクセストークンが設定されていないか不正な値です

429

アクセス回数が制限を超えました

500

サーバ側で予期しないエラーが発生しました

get /candidates/{candidateId}/comments
https://talentio.com/api/v1/candidates/{candidateId}/comments

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]

指定候補者へのコメントを追加します。

Authorizations:
path Parameters
candidateId
required
integer <int64>

候補者ID

query Parameters
content
required
string

コメント内容。メンションを含む場合は target${xxx@yyy.zzz} の形式で指定してください。

Responses

200

正常なレスポンス

400

不正なリクエストです

401

アクセストークンが設定されていないか不正な値です

429

アクセス回数が制限を超えました

500

サーバ側で予期しないエラーが発生しました

post /candidates/{candidateId}/comments
https://talentio.com/api/v1/candidates/{candidateId}/comments