Integrations
Get integration details
General
- Introduction
- Getting started
- Implementation guide
- FAQ
Features
Guides
ATS API Reference
- Jobs
- Applications
- Candidates
- Tags
- Users
- Offers
- Rejection reasons
General API Reference
- Kombo Connect
- Integrations
- Filtering
- Custom Fields
- Other
Integrations
Get integration details
Get the specified integration with everything you need to display it to your customer.
GET
/
integrations
/
{integration_id}
Authorization
string
*
Bearer
Authorization
Required
string
Create an API key on the Secrets page in the Kombo dashboard.
integration_id
string
*
integration_id
Required
string
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",
"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
Authorization
string
headerrequiredCreate an API key on the Secrets page in the Kombo dashboard.
Path Parameters
integration_id
string
requiredGET /integrations/:integration_id parameter
Response
200 - application/json
status
enum<string>
requiredAvailable options:
success
data
object
required{
"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
}
]
}
]
}
}