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
Get integration details
Get the specified integration with everything you need to display it to your customer.
Create an API key on the Secrets page in the Kombo dashboard.
GET /integrations/:integration_id parameter
{
"status": "success",
"data": {
"id": "factorial:8d1hpPsbjxUkoCoa1veLZGe5",
"tool": {
"id": "factorial",
"label": "Factorial",
"internal_label": null,
"logo_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/logo.svg",
"icon_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon.svg"
},
"category": "HRIS",
"status": "ACTIVE",
"setup_status": "COMPLETED",
"end_user": {
"organization_name": "Acme",
"creator_email": "example-integration-creator@acme.com",
"origin_id": "2DQJAUtSzzzKP9buDTvUvPk3"
},
"scope_config": {
"id": "B1hu5NGyhdjSq5X3hxEz4bAN",
"name": "Anonymous Scopes"
},
"created_at": "2022-08-07T14:01:29.196Z",
"beta": false,
"read_models": [
{
"id": "hris_employees",
"label": "Employees",
"is_available": true,
"coverage_status": "SUPPORTED",
"scope_config_setting": "ENABLED",
"opted_out_by_customer": false,
"fields": [
{
"id": "date_of_birth",
"is_available": false,
"coverage_status": "SUPPORTED",
"scope_config_setting": "OPTIONAL",
"opted_out_by_customer": true
}
]
}
]
}
}Authorizations
Path Parameters
GET /integrations/:integration_id parameter
Response
success The ID of the connected tool in Kombo (e.g. factorial).
Internal label that can help you debug specific variants of the integration. Only show the label to your users.
URL to an SVG logo of the connected tool. The logo usually contains the tool name.
URL to a square SVG icon of the connected tool.
HRIS, ATS, ASSESSMENT The current status of the integration.
ACTIVE: The integration is syncing data as expected.INVALID: The integration has stopped syncing data because of invalid credentials. To fix this, reach out to your customer to reconnect the integration.INACTIVE: The integration has stopped syncing as it's been manually set to inactive. You can enable it again in the integration's page.
ACTIVE, INVALID, INACTIVE The setup_status is used in conjunction with the filtering and field mapping features. If these are enabled in the connection flow, the integration will start in an "INCOMPLETE" state and move to "COMPLETE" once all steps are finished.
INCOMPLETE: Setup is still in progress. Some steps aren’t finished, so no data is available yet. Syncs only run as needed for setup.FINAL_SYNC_PENDING: Setup is complete, and the final sync is running. Data will be available after this sync is done.COMPLETED: Setup is fully finished, and the integration is ready to use.
INCOMPLETE, FINAL_SYNC_PENDING, COMPLETED YYYY-MM-DDTHH:mm:ss.sssZ
ID of the model (e.g. hris_employees).
Label of the model (e.g. Employees).
Whether the datapoint is available and enabled and not opted out of.
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.
SUPPORTED, UNSUPPORTED, NOT_IMPLEMENTED, UNKNOWN The setting of the datapoint in the scope config that you configured in the Kombo dashboard.
ENABLED, DISABLED, OPTIONAL Whether the datapoint is opted out by your customer in the connection flow.
Key of the field in the API (e.g. first_name).
Whether the datapoint is available and enabled and not opted out of.
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.
SUPPORTED, UNSUPPORTED, NOT_IMPLEMENTED, UNKNOWN The setting of the datapoint in the scope config that you configured in the Kombo dashboard.
ENABLED, DISABLED, OPTIONAL Whether the datapoint is opted out by your customer in the connection flow.
{
"status": "success",
"data": {
"id": "factorial:8d1hpPsbjxUkoCoa1veLZGe5",
"tool": {
"id": "factorial",
"label": "Factorial",
"internal_label": null,
"logo_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/logo.svg",
"icon_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon.svg"
},
"category": "HRIS",
"status": "ACTIVE",
"setup_status": "COMPLETED",
"end_user": {
"organization_name": "Acme",
"creator_email": "example-integration-creator@acme.com",
"origin_id": "2DQJAUtSzzzKP9buDTvUvPk3"
},
"scope_config": {
"id": "B1hu5NGyhdjSq5X3hxEz4bAN",
"name": "Anonymous Scopes"
},
"created_at": "2022-08-07T14:01:29.196Z",
"beta": false,
"read_models": [
{
"id": "hris_employees",
"label": "Employees",
"is_available": true,
"coverage_status": "SUPPORTED",
"scope_config_setting": "ENABLED",
"opted_out_by_customer": false,
"fields": [
{
"id": "date_of_birth",
"is_available": false,
"coverage_status": "SUPPORTED",
"scope_config_setting": "OPTIONAL",
"opted_out_by_customer": true
}
]
}
]
}
}