v3

OpenAPI 3.1.02026-07-311255771.3 MB

General

Get tools

Get a list of the tools (i.e., integrations) enabled in your environment. This can (in combination with the integration_tool parameter of the "Create Link" endpoint) be used to, for example, display a custom list or grid of available integrations to your end users instead of exposing Kombo Connect's standard tool selector.

get/tools/{category}

Path parameters

category'hris' | 'ats' | 'assessment' | 'lms' required

GET /tools/:category Parameter

Response

GET /tools/:category Positive response

status'success' required

Example response

{
  "data": {
    "tools": [
      {
        "id": "factorial",
        "label": "Factorial",
        "internal_label": null,
        "assets": {
          "logo_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/logo.svg",
          "icon_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon.svg",
          "icon_black_url": "https://storage.googleapis.com/kombo-assets/integrations/factorial/icon-black.svg"
        },
        "paid_api_details_markdown": null,
        "fast_track_details_markdown": null,
        "partner_only_details_markdown": null,
        "connection_guide_url": "https://help.kombo.dev/hc/en-us/articles/18743884123409-Factorial-HR-How-do-I-link-my-account",
        "coverage": {
          "read_models": [
            {
              "id": "hris_employees",
              "label": "Employees",
              "coverage_status": "SUPPORTED",
              "fields": [
                {
                  "id": "date_of_birth",
                  "coverage_status": "SUPPORTED"
                }
              ]
            },
            {
              "id": "hris_teams",
              "label": "Groups",
              "coverage_status": "UNSUPPORTED",
              "fields": [
                {
                  "id": "parent_id",
                  "coverage_status": "UNSUPPORTED"
                }
              ]
            }
          ],
          "write_actions": [
            {
              "id": "hris_create_employee",
              "label": "Create employee",
              "coverage_status": "SUPPORTED",
              "fields": [
                {
                  "id": "first_name",
                  "coverage_status": "SUPPORTED"
                }
              ]
            }
          ],
          "features": [
            {
              "id": "automatic_source_writing",
              "label": "Automatic Source Writing",
              "coverage_status": "SUPPORTED"
            }
          ]
        }
      }
    ]
  }
}