API docs by Redocly

Talentio APIドキュメント (1.1.2)

Download OpenAPI specification:

APIについて

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

アクセストークンの設定

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

アクセス制限

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

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

認証

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

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

レスポンスステータス

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

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

候補者

候補者一覧の取得

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

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

status
string
Default: "絞り込みなし"

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

設定値 状態
ongoing 選考中
reject 辞退
fail お見送り
pass 採用
poolActive コンタクト中
poolInactive 非コンタクト中
requisitionIds
Array of int64
Example: requisitionIds=1,2

求人IDを配列で指定します。

jobTitleIds
Array of int64
Example: jobTitleIds=1,2

職種IDを配列で指定します。

stageStatuses
Array of strings
Example: stageStatuses=evaluated_all,pass

選考ステータスを配列で指定します。

設定値 状態
on_evaluating 評価待ち
evaluated_all 判定待ち
pass 通過
failed お見送り
appliedAtFrom
string

応募日時による範囲指定の開始日を指定します。 フォーマットはyyyy/MM/ddです。

appliedAtTo
string

応募日時による範囲指定の終了日を指定します。 フォーマットはyyyy/MM/ddです。

joinedAtFrom
string

入社日による範囲指定の開始日を指定します。 フォーマットはyyyy/MM/ddです。

joinedAtTo
string

入社日による範囲指定の終了日を指定します。 フォーマットはyyyy/MM/ddです。

updatedAtFrom
string

候補者の更新日時による範囲指定の開始日時を指定します。 フォーマットはyyyy-MM-ddThh:mm:ssです。

updatedAtTo
string

候補者の更新日時による範囲指定の終了日時を指定します。 フォーマットはyyyy-MM-ddThh:mm:ssです。

sort
string

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

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

候補者の追加

JSON 文字列をリクエストボディに詰め、リクエストヘッダーの Content-Type に application/json を指定してリクエストしてください。

Authorizations:
bearerAuth
Request Body schema: application/json
lastName
required
string

候補者の姓を指定します。

firstName
required
string

候補者の名を指定します。

requisitionId
required
integer <int64>

求人IDを指定します。

status
string
Default: "ongoing"
Enum: "ongoing" "reject" "fail" "pass" "poolActive" "poolInactive"

候補者ステータスを指定します。

値 意味
ongoing 進行中
reject 辞退
fail お見送り
pass 通過
poolActive コンタクト中
poolInactive 非コンタクト中
lastNameKana
string

候補者の姓のふりがなを指定します。

firstNameKana
string

候補者の名のふりがなを指定します。

email
string

メールアドレスを指定します。

priority
integer <int64>
Default: 0

優先度を指定します。

gender
string
Enum: "male" "female" "otherGender"

性別

値 意味
male 男性
female 女性
otherGender どちらも選ばない
birthday
string <date-time>

誕生日をYYYY-MM-DD形式で指定します。

address
string

住所を指定します。

phone
string

電話番号を指定します。

description
string

補足を指定します。

tagNames
Array of strings

タグ名の配列を指定します。

object

チャネルを指定します。

Array of objects

経歴の配列を指定します。

Array of objects

学歴の配列を指定します。

Array of objects

カスタムフィールドを配列として指定します。

responsibleEmployees
Array of strings

担当者メールアドレスの配列を指定します。

appliedAt
string <date-time>
Default: "実行日時"

応募日時をYYYY-MM-DDTHH:MM:SS±hh:mm形式で指定します。

joinedAt
string <date-time>

入社日をYYYY-MM-DD形式で指定します。

Responses

Request samples

Content type
application/json
{
  • "lastName": "山田",
  • "firstName": "太郎",
  • "requisitionId": 1,
  • "status": "pass",
  • "lastNameKana": "やまだ",
  • "firstNameKana": "たろう",
  • "email": "test@example.com",
  • "priority": 1,
  • "gender": "male",
  • "birthday": "2022-01-01",
  • "address": "東京都",
  • "phone": "090-xxx-xxx",
  • "description": "サンプル補足",
  • "tagNames": [
    ],
  • "channel": {
    },
  • "experiences": [
    ],
  • "educations": [
    ],
  • "customFields": [
    ],
  • "responsibleEmployees": [
    ],
  • "appliedAt": "2022-04-10T13:00:00+09:00",
  • "joinedAt": "2022-01-01"
}

Response samples

Content type
application/json
{
  • "success": 1,
  • "data": {
    }
}

候補者詳細情報の取得

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

選考の評価フォームについて

選考の評価フォーム（items）のtypeの名称とinputの形式は、フォームの種類により異なります。

フォームの種類 type input
5段階評価 5level 指定した数値
スライダー slide 指定した数値
セレクトボックス select 指定した選択項目の名称
合否判定 bool 通過の場合はtrue, お見送りの場合はfalse
なし none
ー
Authorizations:
bearerAuth
path Parameters
candidateId
required
integer <int64>

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

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "lastName": "string",
  • "firstName": "string",
  • "lastNameEn": "string",
  • "firstNameEn": "string",
  • "lastNameKana": "string",
  • "firstNameKana": "string",
  • "gender": "string",
  • "email": "string",
  • "phone": "string",
  • "address": "string",
  • "requisition": {
    },
  • "fixedAt": "2019-08-24T14:15:22Z",
  • "registeredAt": "2019-08-24T14:15:22Z",
  • "appliedAt": "2019-08-24T14:15:22Z",
  • "joinedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "resultComment": "string",
  • "status": "ongoing",
  • "priority": 0,
  • "memo": "string",
  • "url": "string",
  • "responsibleEmployees": [
    ],
  • "tags": [
    ],
  • "customFields": [
    ],
  • "birthAt": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "attachments": [
    ],
  • "educations": {
    },
  • "experiences": [
    ],
  • "languages": [
    ],
  • "licenses": [
    ],
  • "maybeDuplicated": true,
  • "channelId": 0,
  • "channelType": "agent",
  • "channelName": "string",
  • "agentCompany": {
    },
  • "agent": {
    },
  • "referrerEmployee": {
    },
  • "customChannelName": "string",
  • "customChannelNameOptional": "string",
  • "smartHR": {
    },
  • "stages": [
    ]
}

候補者のタグ設定

これは指定した候補者タグの追加ではなく更新するAPIです。
そのため、すでにタグが設定されている場合は、そのタグも指定しないと外れてしまうことにご注意ください。

JSON 文字列をリクエストボディに詰め、リクエストヘッダーの Content-Type に application/json を指定してリクエストしてください。

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects

候補者とタグの情報を配列として指定します。

[例]

  1. リクエスト前の候補者のタグ設定: タグA、タグB
  2. "tagNames": ["タグB", "タグC"]で更新する
  3. リクエスト後の候補者のタグ設定: タグB、タグC

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "success": 1
}

選考

指定候補者に任意の選考を追加

JSON 文字列をリクエストボディに詰め、リクエストヘッダーの Content-Type に application/json を指定してリクエストしてください。

Authorizations:
bearerAuth
path Parameters
candidateId
required
integer <int64>

候補者ID

Request Body schema: application/json
required
Array of objects (StageEmployee)

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

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

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

formTemplateId
integer <int64>

選考に適用する評価フォームテンプレートのIDを指定します。

scheduledAt
string <date-time>

選考日をISO8601形式で設定します。

duration
integer <int64>

選考の所要時間を分単位で設定します。

description
string

補足を文字列として設定します。

Responses

Request samples

Content type
application/json
{
  • "evaluations": [
    ],
  • "type": "resume",
  • "formTemplateId": 1,
  • "scheduledAt": "2022-04-10T13:00:00+09:00",
  • "duration": 60,
  • "description": "これは補足です"
}

Response samples

Content type
application/json
{
  • "success": 1
}

コメント

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

Authorizations:
bearerAuth
path Parameters
candidateId
required
integer <int64>

候補者ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

指定候補者へのコメントを追加

JSON 文字列をリクエストボディに詰め、リクエストヘッダーの Content-Type に application/json を指定してリクエストしてください。

Authorizations:
bearerAuth
path Parameters
candidateId
required
integer <int64>

候補者ID

Request Body schema: application/json
content
required
string

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

Responses

Request samples

Content type
application/json
{
  • "content": "これはコメントです。 ${talentio@example.com} さんご確認お願いします。"
}

Response samples

Content type
application/json
{
  • "success": 1
}

求人

求人一覧の取得

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

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

sort
any

登録日時もしくは更新日時でのソートを指定します。

値 意味
createdAt 登録日時昇順
-createdAt 登録日時降順
updatedAt 更新日時昇順
-updatedAt 更新日時降順
status
string

募集ステータスを指定します。

値 意味
active 募集中の求人
inactive 募集終了の求人
updatedAtFrom
string

求人の更新日時による範囲指定の開始日時を指定します。 フォーマットはyyyy-MM-ddThh:mm:ssです。

updatedAtTo
string

求人の更新日時による範囲指定の終了日時を指定します。 フォーマットはyyyy-MM-ddThh:mm:ssです。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

求人の追加

JSON 文字列をリクエストボディに詰め、リクエストヘッダーの Content-Type に application/json を指定してリクエストしてください。

Authorizations:
bearerAuth
Request Body schema: application/json
name
required
string

求人名を指定します。

jobTitleId
integer <int64>

職種IDを指定します。

status
string
Default: "active"

募集ステータスを指定します。

値 意味
active 募集中
inactive 募集終了
language
required
string

求人の言語を指定します。

値 意味
ja 日本語
en 英語
recruiterIds
Array of integers <int64> [ items <int64 > ]

採用担当者IDの配列を指定します。

recruiterGroupIds
Array of integers <int64> [ items <int64 > ]

採用担当グループIDの配列を指定します。

workspaceIds
Array of integers <int64> [ items <int64 > ]

ワークスペースIDの配列を指定します。

required
object

採用情報項目を指定します。

項目 型 説明
defaultFields object デフォルト項目
additionalFields array 任意項目

Responses

Request samples

Content type
application/json
{
  • "name": "サンプル求人名",
  • "jobTitleId": 1,
  • "status": "active",
  • "language": "ja",
  • "recruiterIds": [
    ],
  • "recruiterGroupIds": [
    ],
  • "workspaceIds": [
    ],
  • "details": {
    }
}

Response samples

Content type
application/json
{
  • "success": 1,
  • "data": {
    }
}

求人詳細の取得

Authorizations:
bearerAuth
path Parameters
requisitionId
required
integer <int64>

取得したい求人IDを設定します

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "jobTitle": {
    },
  • "active": true,
  • "recruiters": [
    ],
  • "recruiterGroups": [
    ],
  • "jobDescriptionDetails": [
    ],
  • "details": [
    ],
  • "companyDetails": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

職種

職種一覧の取得

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1

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

status
string
Default: "絞り込みなし"

職種の状態を指定します。

値 意味
active アクティブな職種
archived アーカイブされた職種
sort
string

登録日時もしくは更新日時でのソートを指定します。

値 意味
createdAt 登録日時昇順
-createdAt 登録日時降順
updatedAt 更新日時昇順
-updatedAt 更新日時降順

Responses

Response samples

Content type
application/json
[
  • {
    }
]

チャネル

チャネル一覧の取得

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

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

sort
any

登録日時もしくは更新日時でのソートを指定します。

値 意味
createdAt 登録日時昇順
-createdAt 登録日時降順
updatedAt 更新日時昇順
-updatedAt 更新日時降順

Responses

Response samples

Content type
application/json
[
  • {
    }
]

評価フォームテンプレート

評価フォームテンプレート一覧の取得

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

取得するページ番号を指定します。1ページ内に含まれる評価フォームテンプレートの数は100です。
取得対象の総数は X-Total ヘッダーで確認することができます。

Responses

Response samples

Content type
application/json
[
  • {
    }
]

評価

指定候補者の指定選考への評価を追加

JSON 文字列をリクエストボディに詰め、リクエストヘッダーの Content-Type に application/json を指定してリクエストしてください。

選考の評価フォームについて

選考の評価フォーム（items）のtypeの名称とinputの形式、 commentの必須有無は、フォームの種類により異なります。

フォームの種類 type input comment
5段階評価 5level 1 〜 5の数値 任意
スライダー slide 指定した最小値〜最大値間の数値 任意
セレクトボックス select 選択項目の項目名 任意
合否判定 bool 通過の場合はtrue, お見送りの場合はfalse 任意
なし none
ー
 必須
Authorizations:
bearerAuth
path Parameters
candidateId
required
integer <int64>

候補者ID

stageId
required
integer <int64>

選考ID

evaluationId
required
integer <int64>

評価ID

Request Body schema: application/json
employeeId
required
integer <int64>

評価の編集をしたメンバーID。このメンバーが評価の最終編集者として設定されます。

finished
required
boolean

評価の提出か下書きかを指定します。

required
Array of objects (EvaluationItem)

評価項目の配列を指定します。

Responses

Request samples

Content type
application/json
{
  • "employeeId": 1,
  • "finished": true,
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "success": 1
}

メンバー

メンバー一覧の取得

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

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

status
string
Default: "絞り込みなし"

メンバーの状態を指定します。

値 意味
active 有効なメンバー
inactive 無効なメンバー
role
string
Default: "絞り込みなし"

メンバーの役割を指定します。

値 意味
admin 管理者
manager マネージャー
member メンバー
sort
string

メンバーのソートを指定します。

値 意味
createdAt 登録日時昇順
-createdAt 登録日時降順
updatedAt 更新日時昇順
-updatedAt 更新日時降順

Responses

Response samples

Content type
application/json
[
  • {
    }
]

グループ

グループ一覧の取得

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

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

sort
string

グループのソートを指定します。

値 意味
createdAt 登録日時昇順
-createdAt 登録日時降順
updatedAt 更新日時昇順
-updatedAt 更新日時降順

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ワークスペース

ワークスペース一覧の取得

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

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

status
string
Default: "絞り込みなし"

ワークスペースの状態を指定します。

値 意味
active アクティブなワークスペース
archived アーカイブされたワークスペース
sort
string

登録日時もしくは更新日時でのソートを指定します。

値 意味
createdAt 登録日時昇順
-createdAt 登録日時降順
updatedAt 更新日時昇順
-updatedAt 更新日時降順

Responses

Response samples

Content type
application/json
[
  • {
    }
]