Skip to main content
GET
/
integrations
/
{integration_id}
TypeScript
import { Kombo } from "@kombo-api/sdk";

const kombo = new Kombo({
  api_key: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await kombo.general.getIntegrationDetails({
    integration_id: "<id>",
  });

  console.log(result);
}

run();
{
  "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"
    },
    "data_expired_at": null,
    "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
          }
        ]
      }
    ],
    "write_actions": [
      {
        "id": "hris_create_employee",
        "label": "Create employee",
        "is_available": true,
        "coverage_status": "SUPPORTED",
        "scope_config_setting": "ENABLED",
        "opted_out_by_customer": false,
        "fields": [
          {
            "id": "first_name",
            "is_available": true,
            "coverage_status": "SUPPORTED"
          }
        ]
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt

Use this file to discover all available pages before exploring further.

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

GET /integrations/:integration_id Positive response

​
status
string
required
Allowed value: "success"
​
data
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"
  },
  "data_expired_at": null,
  "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
        }
      ]
    }
  ],
  "write_actions": [
    {
      "id": "hris_create_employee",
      "label": "Create employee",
      "is_available": true,
      "coverage_status": "SUPPORTED",
      "scope_config_setting": "ENABLED",
      "opted_out_by_customer": false,
      "fields": [
        {
          "id": "first_name",
          "is_available": true,
          "coverage_status": "SUPPORTED"
        }
      ]
    }
  ]
}