- Documentation
- HRIS API
- ATS API
- ATS-Assessment API
- Status
Kombo Connect
- Scopes
- Real-time sync
- Custom Fields
- Webhooks
- Request Logs
- Integration States
- Implementing New Tools
- Deletion Policy
- Partner Credentials
- Passthrough API
- Extend write endpoints
Kombo Connect
Filtering
Integrations
Other
- DATEV Integration
Features
General API Reference
Guides
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
curl --request GET \
--url https://api.kombo.dev/v1/integrations/{integration_id} \
--header 'Authorization: Bearer <token>'{
"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",
"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
Create an API key on the Secrets page in the Kombo dashboard.
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 ACTIVE, INVALID, INACTIVE The ID you have passed initially to the connection flow to create this integration.
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 trough 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 trough 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.
curl --request GET \
--url https://api.kombo.dev/v1/integrations/{integration_id} \
--header 'Authorization: Bearer <token>'{
"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",
"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
}
]
}
]
}
}