Kombo Connect
Get tools
General
- Introduction
- Getting started
- FAQ
Features
Guides
ATS Assessment API Reference
- Packages
- Orders and results
General API Reference
- Kombo Connect
- Integrations
- Filtering
- Custom Fields
- Other
Kombo Connect
Get tools
Get a list of the tools (i.e., integrations) enabled in your environment.
GET
/
tools
/
{category}
Authorization
string
*
Bearer
Authorization
Required
string
Create an API key on the Secrets page in the Kombo dashboard.
category
enum<string>
*
category
Required
enum<string>
GET /tools/:category parameter
{
"status": "success",
"data": {
"tools": [
{
"id": "factorial",
"label": "Factorial",
"internal_label": null,
"assets": {
"logo_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/logo.svg",
"icon_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon.svg",
"icon_black_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon-black.svg"
},
"coverage": {
"read_models": [
{
"id": "hris_employees",
"label": "Employees",
"coverage_status": "SUPPORTED",
"fields": [
{
"id": "date_of_birth",
"coverage_status": "SUPPORTED"
}
]
},
{
"id": "hris_teams",
"label": "Groups",
"coverage_status": "UNSUPPORTED",
"fields": [
{
"id": "parent_id",
"coverage_status": "UNSUPPORTED"
}
]
}
],
"write_actions": [
{
"id": "hris_create_employee",
"label": "Create employee",
"coverage_status": "SUPPORTED"
}
],
"features": [
{
"id": "automatic_source_writing",
"label": "Automatic Source Writing",
"coverage_status": "SUPPORTED"
}
]
}
}
]
}
}This can (in combination with the integration_tool parameter of the “Create Link” endpoint) be used to, for example, display a custom list or grid of available integrations to your end users instead of exposing Kombo Connect’s standard tool selector.
Authorizations
Path Parameters
GET /tools/:category parameter
Available options:
hris, ats, assessment Response
200 - application/json
Available options:
success Internal label that can help you debug specific variants of the integration. Only show the label to your users.
This describes the supported models and actions of this tool.
ID of the model (e.g. hris_employees).
Label of the model (e.g. Employees).
The status of a datapoint of an integrated tool:
SUPPORTED: the tool supports the datapoint and it can be used through Kombo.UNSUPPORTED: the tool does not support the datapoint.NOT_IMPLEMENTED: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid).UNKNOWN: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool.
Available options:
SUPPORTED, UNSUPPORTED, NOT_IMPLEMENTED, UNKNOWN The status of a datapoint of an integrated tool:
SUPPORTED: the tool supports the datapoint and it can be used through Kombo.UNSUPPORTED: the tool does not support the datapoint.NOT_IMPLEMENTED: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid).UNKNOWN: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool.
Available options:
SUPPORTED, UNSUPPORTED, NOT_IMPLEMENTED, UNKNOWN The status of a datapoint of an integrated tool:
SUPPORTED: the tool supports the datapoint and it can be used through Kombo.UNSUPPORTED: the tool does not support the datapoint.NOT_IMPLEMENTED: tool supports the datapoint but it was not integrated by Kombo for a given reason (see coverage grid).UNKNOWN: the datapoint is not integrated yet and Kombo has no information about it's availability in the tool.
Available options:
SUPPORTED, UNSUPPORTED, NOT_IMPLEMENTED, UNKNOWN {
"status": "success",
"data": {
"tools": [
{
"id": "factorial",
"label": "Factorial",
"internal_label": null,
"assets": {
"logo_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/logo.svg",
"icon_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon.svg",
"icon_black_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon-black.svg"
},
"coverage": {
"read_models": [
{
"id": "hris_employees",
"label": "Employees",
"coverage_status": "SUPPORTED",
"fields": [
{
"id": "date_of_birth",
"coverage_status": "SUPPORTED"
}
]
},
{
"id": "hris_teams",
"label": "Groups",
"coverage_status": "UNSUPPORTED",
"fields": [
{
"id": "parent_id",
"coverage_status": "UNSUPPORTED"
}
]
}
],
"write_actions": [
{
"id": "hris_create_employee",
"label": "Create employee",
"coverage_status": "SUPPORTED"
}
],
"features": [
{
"id": "automatic_source_writing",
"label": "Automatic Source Writing",
"coverage_status": "SUPPORTED"
}
]
}
}
]
}
}