Get integration details

GET

integrations

{integration_id}

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",
    "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

Authorization

string

header

required

Create an API key on the Secrets page in the Kombo dashboard.

Path Parameters

integration_id

string

required

GET /integrations/:integration_id parameter

Response

200

application/json

GET /integrations/:integration_id Successful response

status

enum<string>

required

Available options:

success

data

object

required

data.id

string

required

data.tool

object

required

data.category

enum<string>

required

Available options:

HRIS,

ATS,

ASSESSMENT

data.status

enum<string>

required

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.

Available options:

ACTIVE,

INVALID,

INACTIVE

data.setup_status

enum<string>

required

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.

Available options:

INCOMPLETE,

FINAL_SYNC_PENDING,

COMPLETED

data.end_user

object

required

data.scope_config

object

required

data.created_at

string

required

YYYY-MM-DDTHH:mm:ss.sssZ

data.beta

boolean

required

data.read_models

object[]

required

data.read_models.id

string

required

ID of the model (e.g. hris_employees).

data.read_models.label

string

required

Label of the model (e.g. Employees).

data.read_models.is_available

boolean

required

Whether the datapoint is available and enabled and not opted out of.

data.read_models.coverage_status

enum<string>

required

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

data.read_models.scope_config_setting

enum<string>

required

The setting of the datapoint in the scope config that you configured in the Kombo dashboard.

Available options:

ENABLED,

DISABLED,

OPTIONAL

data.read_models.opted_out_by_customer

boolean

required

Whether the datapoint is opted out by your customer in the connection flow.

data.read_models.fields

object[]

required

Example:

{
  "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
        }
      ]
    }
  ]
}

Get tools Delete integration

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",
    "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
          }
        ]
      }
    ]
  }
}

General

Features

Guides

ATS API Reference

General API Reference

Get integration details

Authorizations

Path Parameters

Response