Toggl雇佣
Toggl Hire API允许您为自定义集成或分析导出候选数据。
版本控制
API中的重大更改将作为API的新小版本发布。例如，API版本在URL中指定https://api.hire.www.lizkeller.com/api/v2.1．API的最新版本始终可用v2．我们建议使用API的精确版本。
要查看特定API版本使用的文档，请单击下面的链接。
身份验证
所有端点都要求在请求中提供API密钥。Toggl Hire中每个工作区的API键都可以在集成设置页面上生成。
获得API密钥后，设置授权值的头。无记名(your-api-key)，例如:
授权：不记名11 zu1zoj0pdoqpvez12ppztprr933l6ve25lm0r0bep7961ky3jvde8vjzy2u28错误
如果请求失败，API将返回一个4xx或5xx响应，并在响应体中显示错误详细信息。目前只有error.type字段，其中包含发生错误的类型。类型不应该显示给用户，但它是人类可读的。
{"错误”:{"类型”:“NotFoundError”｝｝分页
有些端点不返回所有记录，而只返回有限数量的记录。属性指定此数量限制参数，该参数具有一定的最大值。方法中的URL可获取多于最大值的记录links.next属性。
Toggl Hire API使用查找分页，其中每个页面都由上一页记录的ID标识。例如，如果端点返回3条URL id分别为100、101和102的记录/端点?限制= 3，你可以使用最后一条记录的ID得到接下来的3个端点:/端点?限制= 3＆after_id =102．
职位空缺¶
职位空缺收集¶
列出所有职位空缺得到/开口
例子URI
得到
https://api.hire.www.lizkeller.com/api/v2/开口
请求
头
授权：不记名xyz
响应
200
头
内容类型：application / json身体
{"数据”:[{"id”:“100””,的名字”:高级JavaScript开发人员”,鼻涕虫”:“JFHSAK2879FLKJE””,created_at”:“2020 - 02 - 10 - t10:00:00””,published_at”:“2020 - 02 - 10 - t10:00:00””,closed_at”:“2020 - 02 - 10 - t10:00:00”})｝模式
{"美元的模式”:“http://json-schema.org/draft-04/schema””,类型”:“对象””,属性”:{"数据”:{"类型”:“数组””,项目”:{"类型”:“对象””,属性”:{"id”:{"类型”:“字符串””,描述”:“职位空缺的唯一标识符”｝”,的名字”:{"类型”:“字符串””,描述”:“职位空缺名称”｝”,鼻涕虫”:{"类型”:“字符串””,描述”:“职位空缺的公共唯一标识符\n\n职位空缺链接可以通过在' https://apply.hire.www.lizkeller.com/ '后面附加段码来构造，例如' https://apply.hire.www.lizkeller.com/KLJFD9283FLKDJ '。”｝”,created_at”:{"类型”:“字符串””,描述”:“职位空缺创建的日期和时间”｝”,published_at”:{"类型”:［“字符串”，“零”］”,描述”:“发布职位空缺的日期和时间\ \n\n这通常与职位空缺的创建时间相同，除了一些较老的职位空缺。”｝”,closed_at”:{"类型”:［“字符串”，“零”］”,描述”:"职位空缺关闭的日期和时间\n\ n如果该值不为' null '，则职位空缺已关闭，考生不能再参加考试"｝｝｝｝｝｝职位空缺¶
找一个工作机会得到/机会/ {id}
例子URI
得到
https://api.hire.www.lizkeller.com/api/v2/机会/One hundred.
URI参数
- id
-
字符串(必需) 例子:One hundred.所请求的职位空缺的ID
请求
头
授权：不记名xyz
响应
200
头
内容类型：application / json身体
{"id”:“100””,的名字”:高级JavaScript开发人员”,鼻涕虫”:“JFHSAK2879FLKJE””,created_at”:“2020 - 02 - 10 - t10:00:00””,published_at”:“2020 - 02 - 10 - t10:00:00””,closed_at”:“2020 - 02 - 10 - t10:00:00”｝模式
{"美元的模式”:“http://json-schema.org/draft-04/schema””,类型”:“对象””,属性”:{"id”:{"类型”:“字符串””,描述”:“职位空缺的唯一标识符”｝”,的名字”:{"类型”:“字符串””,描述”:“职位空缺名称”｝”,鼻涕虫”:{"类型”:“字符串””,描述”:“职位空缺的公共唯一标识符\n\n职位空缺链接可以通过在' https://apply.hire.www.lizkeller.com/ '后面附加段码来构造，例如' https://apply.hire.www.lizkeller.com/KLJFD9283FLKDJ '。”｝”,created_at”:{"类型”:“字符串””,描述”:“职位空缺创建的日期和时间”｝”,published_at”:{"类型”:［“字符串”，“零”］”,描述”:“发布职位空缺的日期和时间\ \n\n这通常与职位空缺的创建时间相同，除了一些较老的职位空缺。”｝”,closed_at”:{"类型”:［“字符串”，“零”］”,描述”:"职位空缺关闭的日期和时间\n\ n如果该值不为' null '，则职位空缺已关闭，考生不能再参加考试"｝｝｝候选人¶
候选人集合¶
注意，考生集合将只返回提交了考试的考生，而不会返回任何演示考生。
参数组合使用和运算符，这意味着候选对象必须匹配结果中包含的每个参数。
候选人名单得到/{候选人吗?category_id添加,job_opening_id tag_ids、hire_state min_score, max_score, min_rating, max_rating,电子邮件,after_id,极限,}
例子URI
得到
https://api.hire.www.lizkeller.com/api/v2/候选人吗?job_opening_id =One hundred.＆category_id添加=200＆tag_ids =300301302年＆hire_state =possible-hire＆min_score =40＆max_score =70＆min_rating =1＆max_rating =3.＆电子邮件=john@example.com＆after_id =200＆限制=30.＆订单=asc
URI参数
- job_opening_id
-
字符串(可选) 例子:One hundred.返回指定职位空缺的候选人
- category_id添加
-
字符串(可选) 例子:200返回指定类别的候选人
- tag_ids
-
字符串(可选) 例子:300301302年返回具有所有指定标记的候选对象
要指定多个标签，id之间用逗号分隔，例如:
100200300年 - hire_state
-
字符串(可选) 例子:possible-hire返回具有指定雇用状态的候选人
选择:
possible-hire拒绝了 - min_score
-
数量(可选) 例子:40返回至少具有指定分数的考生
- max_score
-
数量(可选) 例子:70最多返回指定分数的考生
- min_rating
-
数量(可选) 例子:1返回至少具有指定评级的候选对象
评级对应于应用程序中的星星，因此1星=评级值
1， 3星=评分值3.． - max_rating
-
数量(可选) 例子:3.返回最多具有指定评级的候选人
- 电子邮件
-
字符串(可选) 例子:john@example.com返回具有指定电子邮件地址的候选人
- after_id
-
字符串(可选) 例子:200用于分页;返回具有指定ID的候选人之后的候选人
- 限制
-
数量(可选) 默认值:One hundred. 例子:30.最多只返回指定数量的候选项
- 订单
-
字符串(可选) 默认值:asc 例子:asc属性对候选对象进行排序
started_at按升序或降序排列选择:
ascdesc
请求
头
授权：不记名xyz
响应
200
头
内容类型：application / json身体
{"数据”:[{"id”:“100””,的名字”:“绳Briemer””,电子邮件”:“rosario84@real.com””,profile_url”:“https://github.com/debitis””,contact_info”:{"full_name”:“绳Briemer””,contact_email”:“acarmona@duran-gomez.info””,linkedin”:“https://linkedin.com/in/debitis””,电话”:“+ 49 (0)9859 103312”,城市”:“Justinville湖””,国家”:“直布罗陀”｝”,点”:12”,分数”:85.714286”,评级”:0”,hire_state”:“possible-hire””,category_id添加”:“100””,job_opening_id”:“100””,utm_source”:“facebook””,utm_medium”:“social_media””,utm_campaign”:“our_facebook_ad””,referrer_url”:“http://facebook.com””,ip_address”:“192.168.0.1””,测试”:[{"类型”:“测试””,started_at”:“2019 - 03 - 10 - t02:39:32.59275””,finished_at”:“2019 - 03 - 10 - t02:53:29.05823””,点”:12”,分数”:85.714286})})”,链接”:{"下一个”:“你好,世界!”｝”,总计”:1｝模式
{"美元的模式”:“http://json-schema.org/draft-04/schema””,类型”:“对象””,属性”:{"数据”:{"类型”:“数组””,项目”:{"类型”:“对象””,属性”:{"id”:{"类型”:“字符串””,描述”:“候选人的唯一标识符”｝”,的名字”:{"类型”:“字符串””,描述”:“从第三方登录提供商获取的候选人姓名\n\n注意，这可能是一个空字符串，例如，如果候选人在GitHub配置文件中没有设置姓名。”｝”,电子邮件”:{"类型”:“字符串””,描述”:“从第三方登录提供商检索的候选人电子邮件”｝”,profile_url”:{"类型”:“字符串””,描述”:“从候选人的第三方登录提供商获取的配置文件URL \n\n注意，只有当候选人使用GitHub登录时，配置文件URL才可用。”｝”,contact_info”:{"类型”:“对象””,属性”:{"full_name”:{"类型”:“字符串””,描述”:“候选人全名”｝”,contact_email”:{"类型”:“字符串””,描述”:“候选人的首选联系邮箱地址”｝”,linkedin”:{"类型”:“字符串””,描述”:“候选人的LinkedIn资料网址”｝”,电话”:{"类型”:“字符串””,描述”:“考生电话号码”｝”,城市”:{"类型”:“字符串””,描述”:“候选人的城市”｝”,国家”:{"类型”:“字符串””,描述”:“候选人的国家”｝｝”,描述”:“考生在考试结束后提交的联系方式”｝”,点”:{"类型”:“数量””,描述”:考生在第一次考试中所有答案的得分总和｝”,分数”:{"类型”:“数量””,描述”:考生第一次考试按“实际分数”/“最高分数”计算的百分率｝”,评级”:{"类型”:“数量””,枚举”:［0，1，2，3.］”,描述”:“候选人的星级评价”｝”,hire_state”:{"类型”:“字符串””,枚举”:［“possible-hire”，“拒绝”，“(空字符串)”］”,描述”:“应聘者的受雇状态”｝”,category_id添加”:{"类型”:［“字符串”，“零”］”,描述”:“候选人所属类别的编号”｝”,job_opening_id”:{"类型”:“字符串””,描述”:“候选人职位空缺的编号”｝”,utm_source”:{"类型”:“字符串””,描述”:候选人访问测试时使用的utm_source查询参数｝”,utm_medium”:{"类型”:“字符串””,描述”:候选人访问测试时使用的utm_medium查询参数｝”,utm_campaign”:{"类型”:“字符串””,描述”:"候选人使用的utm_campaign查询参数"｝”,referrer_url”:{"类型”:“字符串””,描述”:“考生从推荐人导航到考试”｝”,ip_address”:{"类型”:“字符串””,描述”:“候选人的IP地址”｝”,测试”:{"类型”:“数组””,描述”:"候选人参加的测试"｝｝｝｝”,链接”:{"类型”:“对象””,属性”:{"下一个”:{"类型”:“字符串””,描述”:可用于获取下一页的URL｝｝｝”,总计”:{"类型”:“数量””,描述”:“匹配参数的候选总数”｝｝｝候选人¶
获取一个候选人得到候选人/ {id}
例子URI
得到
https://api.hire.www.lizkeller.com/api/v2候选人/id
URI参数
- id
-
字符串(必需)被请求候选人的ID
请求
头
授权：不记名xyz
响应
200
头
内容类型：application / json身体
{"id”:“100””,的名字”:“绳Briemer””,电子邮件”:“rosario84@real.com””,profile_url”:“https://github.com/debitis””,contact_info”:{"full_name”:“绳Briemer””,contact_email”:“acarmona@duran-gomez.info””,linkedin”:“https://linkedin.com/in/debitis””,电话”:“+ 49 (0)9859 103312”,城市”:“Justinville湖””,国家”:“直布罗陀”｝”,点”:3.”,分数”:One hundred.”,评级”:1”,hire_state”:“possible-hire””,category_id添加”:“100””,job_opening_id”:“100””,tag_ids”:［“100”，“200”，“300”］”,utm_source”:“facebook””,utm_medium”:“social_media””,utm_campaign”:“our_facebook_ad””,referrer_url”:“http://facebook.com””,ip_address”:“192.168.0.1””,测试”:[{"类型”:“测试””,started_at”:“2019 - 03 - 10 - t02:39:32.59275””,finished_at”:“2019 - 03 - 10 - t02:53:29.05823””,点”:1”,分数”:One hundred.”,问题”:[{"id”:“400””,question_type”:“单一选择””,内容”:“哪个词更能形容**你?””,点”:3.”,选项”:[{"id”:“500””,内容”:“完成胜于完美””,正确的”:真正的}， {"id”:“501””,内容”:"我做任何事都追求完美"”,正确的”:假})}， {"id”:“401””,question_type”:“自由文本””,内容”:“你有什么专业经验?””,点”:0”,选项”:［］})”,答案”:[{"question_id”:“400””,text_answer”:＂＂”,点”:3.”,chosen_option_ids”:［“500”］}， {"question_id”:“401””,text_answer”:“无论做什么，我都是世界上最好的。””,点”:0”,chosen_option_ids”:［］})”,技能”:[{"技能”:“Golang””,分数”:75.5})}， {"类型”:“视频””,started_at”:“2019 - 03 - 10 - t03:39:32.59275””,finished_at”:“2019 - 03 - 10 - t03:53:29.05823””,点”:0”,问题”:[{"id”:“702””,技能”:零”,内容”:“这周发生在你身上最好的事情是什么?””,点”:1”,选项”:［］})”,答案”:[{"question_id”:“702””,text_answer”:＂＂”,recording_url”:“http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/BigBuckBunny.mp4””,点”:零”,chosen_option_ids”:［］})”,技能”:［］})｝模式
{"美元的模式”:“http://json-schema.org/draft-04/schema””,类型”:“对象””,属性”:{"id”:{"类型”:“字符串””,描述”:“候选人的唯一标识符”｝”,的名字”:{"类型”:“字符串””,描述”:“从第三方登录提供商获取的候选人姓名\n\n注意，这可能是一个空字符串，例如，如果候选人在GitHub配置文件中没有设置姓名。”｝”,电子邮件”:{"类型”:“字符串””,描述”:“从第三方登录提供商检索的候选人电子邮件”｝”,profile_url”:{"类型”:“字符串””,描述”:“从候选人的第三方登录提供商获取的配置文件URL \n\n注意，只有当候选人使用GitHub登录时，配置文件URL才可用。”｝”,contact_info”:{"类型”:“对象””,属性”:{"full_name”:{"类型”:“字符串””,描述”:“候选人全名”｝”,contact_email”:{"类型”:“字符串””,描述”:“候选人的首选联系邮箱地址”｝”,linkedin”:{"类型”:“字符串””,描述”:“候选人的LinkedIn资料网址”｝”,电话”:{"类型”:“字符串””,描述”:“考生电话号码”｝”,城市”:{"类型”:“字符串””,描述”:“候选人的城市”｝”,国家”:{"类型”:“字符串””,描述”:“候选人的国家”｝｝”,描述”:“考生在考试结束后提交的联系方式”｝”,点”:{"类型”:“数量””,描述”:考生在第一次考试中所有答案的得分总和｝”,分数”:{"类型”:“数量””,描述”:考生第一次考试按“实际分数”/“最高分数”计算的百分率｝”,评级”:{"类型”:“数量””,枚举”:［0，1，2，3.］”,描述”:“候选人的星级评价”｝”,hire_state”:{"类型”:“字符串””,枚举”:［“possible-hire”，“拒绝”，“(空字符串)”］”,描述”:“应聘者的受雇状态”｝”,category_id添加”:{"类型”:［“字符串”，“零”］”,描述”:“候选人所属类别的编号”｝”,job_opening_id”:{"类型”:“字符串””,描述”:“候选人职位空缺的编号”｝”,utm_source”:{"类型”:“字符串””,描述”:候选人访问测试时使用的utm_source查询参数｝”,utm_medium”:{"类型”:“字符串””,描述”:候选人访问测试时使用的utm_medium查询参数｝”,utm_campaign”:{"类型”:“字符串””,描述”:"候选人使用的utm_campaign查询参数"｝”,referrer_url”:{"类型”:“字符串””,描述”:“考生从推荐人导航到考试”｝”,ip_address”:{"类型”:“字符串””,描述”:“候选人的IP地址”｝”,测试”:{"类型”:“数组””,描述”:"候选人参加的测试"｝”,tag_ids”:{"类型”:“数组””,描述”:"分配给候选人的标签id "｝｝｝类别¶
分类收集¶
列出所有类别得到{/类别?job_opening_id}
例子URI
得到
https://api.hire.www.lizkeller.com/api/v2/类别?job_opening_id =
URI参数
- job_opening_id
-
字符串(可选)只返回指定作业开头的类别
请求
头
授权：不记名xyz
响应
200
头
内容类型：application / json身体
{"数据”:[{"id”:“100””,的名字”:“面试””,job_opening_id”:“200”})｝模式
{"美元的模式”:“http://json-schema.org/draft-04/schema””,类型”:“对象””,属性”:{"数据”:{"类型”:“数组””,项目”:{"类型”:“对象””,属性”:{"id”:{"类型”:“字符串””,描述”:“类别的唯一标识符”｝”,的名字”:{"类型”:“字符串””,描述”:“类别名称”｝”,job_opening_id”:{"类型”:“字符串””,描述”:"打开类别所属的作业的ID "｝｝｝｝｝｝