Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kombo General API

The General API from Kombo — 12 operation(s) for general.

Kombo General API is one of 8 APIs that Kombo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include General. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 13 operations across 12 paths, and defines 39 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.kombo.dev/v1, https://api.us.kombo.dev/v1.

13 operations 12 paths 39 schemas 1 DELETE5 GET1 PATCH4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.kombo.dev
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Kombo General API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (ApiKey). By default, every request must be authenticated.

  • ApiKey — Create an API key on the [Secrets](https://app.kombo.dev/secrets) page in the Kombo dashboard.

Paths & Operations 13

Across 12 paths, the API surfaces 13 operations — 1 DELETE, 5 GET, 1 PATCH, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

General 13
GET
/check-api-key
Check API key
GetCheckApiKey → 200default
POST
/force-sync
Trigger sync
PostForceSync 1 param body → 200default
POST
/passthrough/{tool}/{api}
Send passthrough request
PostPassthroughToolApi 3 params body → 200default
DELETE
/integrations/{integration_id}
Delete integration
DeleteIntegrationsIntegrationId 1 param body → 200default
GET
/integrations/{integration_id}
Get integration details
GetIntegrationsIntegrationId 1 param → 200default
PUT
/integrations/{integration_id}/enabled
Set integration enabled
PutIntegrationsIntegrationIdEnabled 1 param body → 200default
POST
/integrations/{integration_id}/relink
Create reconnection link
PostIntegrationsIntegrationIdRelink 1 param body → 200default
POST
/integrations/{integration_id}/setup-link
Create Setup Flow link
PostIntegrationsIntegrationIdSetupLink 1 param body → 200default
GET
/integrations/{integration_id}/integration-fields
Get integration fields
GetIntegrationsIntegrationIdIntegrationFields 3 params → 200default
PATCH
/integrations/{integration_id}/integration-fields/{integration_field_id}
Updates an integration fields passthrough setting
PatchIntegrationsIntegrationIdIntegrationFieldsIntegrationFieldId 2 params body → 200default
GET
/integrations/{integration_id}/custom-fields
Get custom fields with current mappings
GetIntegrationsIntegrationIdCustomFields 3 params → 200default
PUT
/integrations/{integration_id}/custom-fields/{custom_field_id}
Put custom field mappings
PutIntegrationsIntegrationIdCustomFieldsCustomFieldId 2 params body → 200default
GET
/tools/{category}
Get tools
GetToolsCategory 1 param → 200default

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are PostPassthroughToolApiRequestBody (8 properties), PostIntegrationsIntegrationIdRelinkRequestBody (3 properties), PostPassthroughToolApiPositiveResponse (3 properties), GetToolsCategoryPositiveResponse (2 properties). Each schema is shown below with its type and property counts.

GetToolsCategoryPositiveResponse
object
2 properties 2 required
PutIntegrationsIntegrationIdCustomFieldsCustomFieldIdPositiveResponse
object
2 properties 2 required
PostIntegrationsIntegrationIdSetupLinkRequestBody
object
2 properties 1 required
PostIntegrationsIntegrationIdSetupLinkParameterIntegrationId
string
PostIntegrationsIntegrationIdSetupLinkPositiveResponse
object
2 properties 2 required
DeleteIntegrationsIntegrationIdParameterIntegrationId
string
PutIntegrationsIntegrationIdEnabledParameterIntegrationId
string
PostPassthroughToolApiParameterApi
string
The ID of the passthrough API you want to call (some tools provide multiple). Check the endpoint description for a list of all available APIs.
PostIntegrationsIntegrationIdRelinkPositiveResponse
object
2 properties 2 required
PostPassthroughToolApiPositiveResponse
object
3 properties 3 required
GetIntegrationsIntegrationIdIntegrationFieldsParameterPageSize
integer
The number of results to return per page. Maximum is 2000.
GetIntegrationsIntegrationIdParameterIntegrationId
string
GetIntegrationsIntegrationIdIntegrationFieldsPositiveResponse
object
2 properties 2 required
GetIntegrationsIntegrationIdCustomFieldsPositiveResponse
object
2 properties 2 required
GetIntegrationsIntegrationIdCustomFieldsParameterPageSize
integer
The number of results to return per page. Maximum is 250.
GetToolsCategoryParameterCategory
string
GetIntegrationsIntegrationIdPositiveResponse
object
2 properties 2 required
PostForceSyncRequestBody
object
1 property
PostForceSyncPositiveResponse
object
2 properties 2 required
PutIntegrationsIntegrationIdCustomFieldsCustomFieldIdParameterCustomFieldId
string
The unique ID of the custom field that should be updated
GetIntegrationsIntegrationIdIntegrationFieldsParameterCursor
string
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
PatchIntegrationsIntegrationIdIntegrationFieldsIntegrationFieldIdParameterIntegrationId
string
GetCheckApiKeyPositiveResponse
object
2 properties 2 required
PutIntegrationsIntegrationIdCustomFieldsCustomFieldIdParameterIntegrationId
string
The unique ID of the integration where the custom field mapping should be updated
PatchIntegrationsIntegrationIdIntegrationFieldsIntegrationFieldIdParameterIntegrationFieldId
string
GetIntegrationsIntegrationIdCustomFieldsParameterIntegrationId
string
PutIntegrationsIntegrationIdEnabledPositiveResponse
object
2 properties 2 required
GetIntegrationsIntegrationIdCustomFieldsParameterCursor
string
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
DeleteIntegrationsIntegrationIdRequestBody
object
PatchIntegrationsIntegrationIdIntegrationFieldsIntegrationFieldIdRequestBody
object
1 property 1 required
PutIntegrationsIntegrationIdEnabledRequestBody
object
1 property 1 required
DeleteIntegrationsIntegrationIdPositiveResponse
object
2 properties 2 required
PutIntegrationsIntegrationIdCustomFieldsCustomFieldIdRequestBody
object
1 property 1 required
GetIntegrationsIntegrationIdIntegrationFieldsParameterIntegrationId
string
PostIntegrationsIntegrationIdRelinkParameterIntegrationId
string
PostIntegrationsIntegrationIdRelinkRequestBody
object
3 properties
PostPassthroughToolApiRequestBody
object
8 properties 2 required
PostPassthroughToolApiParameterTool
string
The ID of the tool whose passthrough API you want to call (e.g., personio).
PatchIntegrationsIntegrationIdIntegrationFieldsIntegrationFieldIdPositiveResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kombo-general-api-openapi.yml Raw ↑

Other APIs Kombo publishes across the network.

Kombo AI Apply API
Kombo Custom Endpoints API
Kombo Kombo Connect API
Kombo Unified ATS API API
Kombo Unified ATS (Assessment & Background Check) API API
Kombo Unified HRIS API API
Kombo Unified LMS API API