General
Features
Guides
ATS Assessment API Reference
Python
Copy
Ask AI
from kombo import Kombo
with Kombo(
api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:
res = k_client.general.get_tools(category="ats")
# Handle response
print(res)Copy
Ask AI
{
"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"
},
"paid_api_details_markdown": null,
"fast_track_details_markdown": null,
"partner_only_details_markdown": null,
"connection_guide_url": "https://help.kombo.dev/hc/en-us/articles/18743884123409-Factorial-HR-How-do-I-link-my-account",
"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",
"fields": [
{
"id": "first_name",
"coverage_status": "SUPPORTED"
}
]
}
],
"features": [
{
"id": "automatic_source_writing",
"label": "Automatic Source Writing",
"coverage_status": "SUPPORTED"
}
]
}
}
]
}
}Kombo Connect
Get tools
Get a list of the tools (i.e., integrations) enabled in your environment.
GET
/
tools
/
{category}
Python
Copy
Ask AI
from kombo import Kombo
with Kombo(
api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:
res = k_client.general.get_tools(category="ats")
# Handle response
print(res)Copy
Ask AI
{
"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"
},
"paid_api_details_markdown": null,
"fast_track_details_markdown": null,
"partner_only_details_markdown": null,
"connection_guide_url": "https://help.kombo.dev/hc/en-us/articles/18743884123409-Factorial-HR-How-do-I-link-my-account",
"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",
"fields": [
{
"id": "first_name",
"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
GET /tools/:category Positive response
Allowed value:
"success"Show child attributes
Show child attributes
Show child attributes
Show child attributes
Internal label that can help you debug specific variants of the integration. Only show the label to your users.
Markdown formatted text that describes details about the paid API. null if the tool is not paid.
Markdown formatted text that describes details about the fast track process. null if the fast track process is not available.
Markdown formatted text that describes partnership requirements. null if the tool does not require a partnership.
URL to the connection guide for this tool. null if no connection guide is available.
This describes the supported models and actions of this tool.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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 Show child attributes
Show child attributes
Key of the field in the model (e.g. first_name).
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 Show child attributes
Show child attributes
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 Show child attributes
Show child attributes
Key of the input field (e.g. candidate.first_name).
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 Show child attributes
Show child attributes
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 Was this page helpful?
⌘I