Download OpenAPI specification:Download
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 | 認証に失敗した |
429 | アクセス回数が制限を超えた |
500 | サーバー側で予期しないエラーが発生した |
page | integer <int64> >= 1 取得するページ番号を指定します。1ページ内に含まれる候補者数は100です。 | ||||||||||||||
status | string Default: "絞り込みなし" 候補者のステータスで絞り込みます。
| ||||||||||||||
appliedAtFrom | string 応募日による範囲指定の開始日を指定します。 フォーマットは | ||||||||||||||
appliedAtTo | string 応募日による範囲指定の終了日を指定します。 フォーマットは | ||||||||||||||
joinedAtFrom | string 入社日による範囲指定の開始日を指定します。 フォーマットは | ||||||||||||||
joinedAtTo | string 入社日による範囲指定の終了日を指定します。 フォーマットは | ||||||||||||||
sort | string 登録日もしくは応募日でのソートを指定します。
|
[- {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "firstNameEn": "string",
- "lastNameEn": "string",
- "firstNameKana": "string",
- "lastNameKana": "string",
- "gender": "string",
- "email": "string",
- "phone": "string",
- "address": "string",
- "requisition": {
- "id": 0,
- "name": "string",
- "active": true,
- "jobTitle": {
- "id": 0,
- "name": "string"
}
}, - "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",
- "stages": [
- {
- "id": 0,
- "type": "string",
- "step": 0,
- "scheduledAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "resultComment": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "fixedAt": "2019-08-24T14:15:22Z",
- "status": "ongoing"
}
], - "status": "ongoing",
- "priority": 0,
- "memo": "string",
- "url": "string",
- "responsibleEmployees": [
- {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "string"
}
], - "tags": [
- {
- "id": 0,
- "name": "string"
}
], - "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "birthAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "attachments": [
- {
- "id": 0,
- "fileName": "string",
- "url": "string"
}
], - "educations": [
- {
- "school": "string",
- "faculty": "string",
- "startAt": "string",
- "endAt": "string",
- "description": "string",
- "active": true
}
], - "experiences": [
- {
- "company": "string",
- "position": "string",
- "startAt": "string",
- "endAt": "string",
- "description": "string",
- "active": true
}
], - "languages": [
- {
- "name": "string",
- "level": 0
}
], - "licenses": [
- {
- "name": "string",
- "acquiredAt": "string"
}
], - "channelType": "agent",
- "channelName": "string",
- "agentCompany": {
- "id": 0,
- "name": "string"
}, - "agent": {
- "id": 0,
- "name": "string",
- "email": "string",
- "active": true
}, - "referrerEmployee": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "active": true
}, - "customChannelName": "string",
- "customChannelNameOptional": "string",
- "smartHR": {
- "crewId": 0
}
}
]
JSON 文字列をリクエストボディに詰め、リクエストヘッダーの Content-Type
に application/json
を指定してリクエストしてください。
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": ["タグ1", "タグ2"],
"channel": {
"type": "site"
},
"experiences": [{
"company": "サンプル会社名",
"position": "サンプルポジション",
"startAt": "2022-01-01",
"endAt": "2022-01-31",
"description": "サンプル補足",
"active": true
}],
"educations": [{
"school": "サンプル学校名",
"faculty": "サンプル学科",
"startAt": "2022-01-01",
"endAt": "2022-01-31",
"description": "サンプル補足",
"active": true
}],
"customFields": [{
"name": "サンプル自由テキスト",
"value": "自由な\n文章"
},{
"name": "サンプル1行テキスト",
"value": "foo"
},{
"name": "サンプル数値",
"value": 10
},{
"name": "サンプルセレクトボックス",
"value": "はい"
},{
"name": "サンプルチェックボックス",
"value": ["A", "B"]
},{
"name": "サンプル日付",
"value": "2022-01-01"
}],
"appliedAt": "2022-04-10T13:00:00+09:00",
"joinedAt": "2022-01-01"
}
lastName required | string 候補者の姓を指定します。 | ||||||||||||||
firstName required | string 候補者の名を指定します。 | ||||||||||||||
requisitionId required | integer <int64> 求人IDを指定します。 | ||||||||||||||
status | string Default: "ongoing" Enum: "ongoing" "reject" "fail" "pass" "poolActive" "poolInactive" 候補者ステータスを指定します。
| ||||||||||||||
lastNameKana | string 候補者の姓のふりがなを指定します。 | ||||||||||||||
firstNameKana | string 候補者の名のふりがなを指定します。 | ||||||||||||||
string メールアドレスを指定します。 | |||||||||||||||
priority | integer <int64> Default: 0 優先度を指定します。 | ||||||||||||||
gender | string Enum: "male" "female" "otherGender" 性別
| ||||||||||||||
birthday | string <date-time> 誕生日を | ||||||||||||||
address | string 住所を指定します。 | ||||||||||||||
phone | string 電話番号を指定します。 | ||||||||||||||
description | string 補足を指定します。 | ||||||||||||||
tagNames | Array of strings タグ名の配列を指定します。 | ||||||||||||||
object チャネルを指定します。チャネルのタイプごとにパラメータの仕様が変わります。 | |||||||||||||||
Array of objects 経歴の配列を指定します。 | |||||||||||||||
Array of objects 学歴の配列を指定します。 | |||||||||||||||
Array of objects カスタムフィールドを配列として指定します。 | |||||||||||||||
appliedAt | string <date-time> Default: "実行日時" 応募日を | ||||||||||||||
joinedAt | string <date-time> 入社日を |
{- "success": 1,
- "data": {
- "id": 1
}
}
候補者一覧に含まれない、候補者の選考の各評価などの情報を取得することができます。
選考の評価フォーム(items
)のtype
の名称とinput
の形式は、フォームの種類により異なります。
フォームの種類 | type | input |
---|---|---|
5段階評価 | 5level | 指定した数値 |
スライダー | slide | 指定した数値 |
セレクトボックス | select | 指定した選択項目の名称 |
合否判定 | bool | 通過の場合はtrue , お見送りの場合はfalse |
なし | none | ー |
candidateId required | integer <int64> 取得したい候補者の候補者idを設定します |
{- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "firstNameEn": "string",
- "lastNameEn": "string",
- "firstNameKana": "string",
- "lastNameKana": "string",
- "gender": "string",
- "email": "string",
- "phone": "string",
- "address": "string",
- "requisition": {
- "id": 0,
- "name": "string",
- "active": true,
- "jobTitle": {
- "id": 0,
- "name": "string"
}
}, - "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",
- "stages": [
- {
- "id": 0,
- "type": "string",
- "step": 0,
- "scheduledAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "resultComment": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "fixedAt": "2019-08-24T14:15:22Z",
- "status": "ongoing",
- "evaluations": [
- {
- "id": 0,
- "finished": true,
- "items": [
- {
- "name": "string",
- "type": "string",
- "input": "string",
- "comment": "string"
}
], - "scheduledAt": "2019-08-24T14:15:22Z",
- "evaluatedAt": "2019-08-24T14:15:22Z",
- "employee": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "active": true
}
}
]
}
], - "status": "ongoing",
- "priority": 0,
- "memo": "string",
- "url": "string",
- "tags": [
- {
- "id": 0,
- "name": "string"
}
], - "customFields": [
- {
- "name": "string",
- "value": "string"
}
], - "birthAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "attachments": [
- {
- "id": 0,
- "fileName": "string",
- "url": "string"
}
], - "educations": [
- {
- "school": "string",
- "faculty": "string",
- "startAt": "string",
- "endAt": "string",
- "description": "string",
- "active": true
}
], - "experiences": [
- {
- "company": "string",
- "position": "string",
- "startAt": "string",
- "endAt": "string",
- "description": "string",
- "active": true
}
], - "languages": [
- {
- "name": "string",
- "level": 0
}
], - "licenses": [
- {
- "name": "string",
- "acquiredAt": "string"
}
], - "channelType": "agent",
- "channelName": "string",
- "agentCompany": {
- "id": 0,
- "name": "string"
}, - "agent": {
- "id": 0,
- "name": "string",
- "email": "string",
- "active": true
}, - "referrerEmployee": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "active": true
}, - "customChannelName": "string",
- "customChannelNameOptional": "string",
- "smartHR": {
- "crewId": 0
}
}
JSON 文字列をリクエストボディに詰め、リクエストヘッダーの Content-Type
に application/json
を指定してリクエストしてください。
JSON 例
{
"evaluations":[
{"employee":"sample1@talentio.com"},
{"employee":"sample2@talentio.com"}
],
"type":"resume",
"scheduledAt": "2022-04-10T13:00:00+09:00",
"description": "これは補足です"
}
candidateId required | integer <int64> 候補者ID |
required | Array of objects (StageEmployee) 評価者を |
type required | string Enum: "contact" "resume" "interview" "reference" "final" 選考種別を指定します。指定可能な文字列は以下になります。 |
scheduledAt | string <date-time> 選考日をISO8601形式で設定します。 |
description | string 補足を文字列として設定します。 |
{- "success": 1
}
candidateId required | integer <int64> 候補者ID |
[- {
- "content": "string",
- "employeeCreatedBy": {
- "id": 0,
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "active": true
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
JSON 文字列をリクエストボディに詰め、リクエストヘッダーの Content-Type
に application/json
を指定してリクエストしてください。
JSON 例
{
"content":"これはコメントです。 ${talentio@example.com} さんご確認お願いします。"
}
candidateId required | integer <int64> 候補者ID |
content required | string コメント内容。メンションを含む場合は |
{- "success": 1
}
page | integer <int64> >= 1 取得するページ番号を指定します。1ページ内に含まれる求人数は100です。 | ||||||||||
sort | any 登録日もしくは更新日でのソートを指定します。
| ||||||||||
status | string 募集ステータスを指定します。
|
[- {
- "id": 0,
- "name": "string",
- "jobTitle": {
- "id": 0,
- "name": "string"
}, - "active": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
requisitionId required | integer <int64> 取得したい求人IDを設定します |
{- "id": 0,
- "name": "string",
- "jobTitle": {
- "id": 0,
- "name": "string"
}, - "active": true,
- "recruiters": [
- {
- "id": 0,
- "name": "string"
}
], - "jobDescriptionDetails": [
- {
- "name": "勤務時間",
- "value": "フレックスタイム制"
}
], - "details": [
- [
- {
- "name": "業務内容",
- "value": "ポジションやそのポジションの魅力、具体的な業務内容などを記載してください"
}, - {
- "name": "勤務地",
- "value": [
- "東京都港区六本木6-3-1",
- "日本全国転勤の可能性あり"
]
}
]
], - "companyDetails": [
- {
- "name": "設立",
- "value": "2013年8月"
}
], - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}