Skip to content

README.md

Latest commit

 

History

History
1058 lines (762 loc) · 122 KB

README.md

File metadata and controls

1058 lines (762 loc) · 122 KB
Raw

General

Overview

Available Operations

check_api_key

Check whether your API key is working properly.

Example Usage

from kombo import Kombo


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.check_api_key()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.GetCheckAPIKeyPositiveResponse

Errors

Error Type Status Code Content Type
errors.KomboGeneralError default application/json
errors.SDKDefaultError 4XX, 5XX */*

trigger_sync

Trigger a sync for a specific integration.

Please note that it is not necessary nor recommended to call this endpoint periodically on your side. Kombo already performs periodic syncs for you and you should only trigger syncs yourself in special cases (like when a user clicks on a "Sync" button in your app).

Example Usage: Error Response

from kombo import Kombo


with Kombo(
    integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.trigger_sync(type_="FULL")

    # Handle response
    print(res)

Example Usage: Minimal Error Response

from kombo import Kombo


with Kombo(
    integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.trigger_sync(type_="FULL")

    # Handle response
    print(res)

Example Usage: example1

from kombo import Kombo


with Kombo(
    integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.trigger_sync(type_="FULL")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
type Optional[models.PostForceSyncRequestBodyType] ➖ The type of the triggered sync.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.PostForceSyncPositiveResponse

Errors

Error Type Status Code Content Type
errors.KomboGeneralError default application/json
errors.SDKDefaultError 4XX, 5XX */*

send_passthrough_request

Send a request to the specified integration's native API.

At Kombo we put a lot of work into making sure that our unified API covers all our customers' use cases and that they never have to think about integration-specific logic again. There are cases, however, where our customers want to build features that are very integration-specific. That's where this endpoint comes in.

Pass in details about the request you want to make to the integration's API and we'll forward it for you. We'll also take care of setting the right base URL and authenticating your requests.

To get started, please pick the relevant API (some tools provide multiple to due different base URLs or authentication schemes) from the table below and pass in the {tool}/{api} identifier as part of the path.

Integration {tool}/{api} Description
360Learning 360learning/v2 360Learning API v2. We automatically handle authentication and use https://app.360learning.com/api/v2/ as the base URL.
a3innuva Nómina a3innuvanomina/laboral a3innuva Nómina API docs. Requests are automatically authenticated using OAuth access tokens (refreshed when needed). Base URL: https://a3api.wolterskluwer.es/Laboral/api.
Abacus Umantis abacusumantis/v1 Umantis API v1. We automatically authenticate all requests and use https://\{subdomain\}.umantis.com/api/v1 as the base URL.
Abacus abacus/api Abacus REST API. We automatically authenticate all requests and use https://\{\{abacusUrl\}\}/api/entity/v1/mandants/\{\{mandantId\}\} as the base URL.
Absence.io absenceio/v2 Absence.io API. We automatically authenticate all requests and use https://app.absence.io/api/v2 as the base URL.
ADP Decidium adpdecidium/default ADP Decidium API. We automatically authenticate all requests and use https://api.eu.adp.com as the base URL.
ADP Workforce Now adpworkforcenow/default ADP Workforce Now API v2. We automatically authenticate all requests and use the correct subdomain.
AFAS Software afas/api AFAS' API. We automatically authenticate all requests and use https://\{domain\}/ProfitRestServices as the base URL.
AlexisHR alexishr/v1 AlexisHR's v1 API We automatically authenticate all requests and use https://\{subdomain\}.alexishr.com as base URL.
ApplicantStack applicantstack/api ApplicantStack's API. We automatically authenticate all requests and use https://\{subdomain\}.applicantstack.com/api/ as the base URL.
Apploi apploi/rest-api The Apploi API. We automatically authenticate all requests and use https://partners.apploi.com/ as the base URL.
Ashby ashby/v1 Ashby's V1 API. We automatically authenticate all requests with the provided credentials and use https://api.ashbyhq.com as the base URL. Please note that Ashby uses an RPC-style API. Please check the Ashby API documentation for details on how to use it.
Asymbl asymbl/v63 We use https://\{subdomain\}.my.salesforce.com as the base URL. Find the official docs here.
Atlas atlas/v1 We use https://api.recruitwithatlas.com/api/v1/ as the base URL. Find the official docs here.
Avature avature/custom-api Avatures's Custom API. Call Get /openapi to retrieve the specific custom API schema. We automatically authenticate all requests and use the instance specific custom API URL as the base URL.
Avionté avionte/front-office-v1 Avionte's API. We automatically authenticate all requests and use https://api.avionte.com/front-office/v1 as the base URL. Documentation for the BOLD Front Office API: https://developer.avionte.com/reference/get-all-talent-tags
BambooHR bamboohr/v1 BambooHR's API. We automatically authenticate all requests using the customer credentials https://api.bamboohr.com/api/gateway.php/\{subdomain\}/v1 as the base URL.
BITE bite/v1 Bite's v1 API. We automatically authenticate all requests and use your configured API base URL with /v1 appended (default https://api.b-ite.io/v1).
BoondManager boondmanager/api BoondManager REST API. We automatically authenticate all requests and use https://ui.boondmanager.com/api as the base URL.
Breezy HR breezyhr/v3 BreezyHR's v3 API. We automatically authenticate all requests and use "https://api.breezy.hr/v3/" as the base URL.
Bullhorn for Salesforce bullhorn4salesforce/v66 We use https://\{subdomain\}.my.salesforce.com/services/data/v66.0 as the base URL. Find the official docs here.
Bullhorn bullhorn/default Bullhorn's API. We automatically use the right https://\{subdomain\}.bullhornstaffing.com/rest-services/\{corpToken\} base URL.
CareerPlug careerplug/api We use https://api.careerplug.com as the base URL. Find the official docs here.
Carerix carerix/api Carerix REST API. We automatically authenticate all requests and use https://api.carerix.com as the base URL. Please note that Carerix uses XML for request and response bodies.
Carerix carerixgraphql/graphql Carerix GraphQL API. We automatically authenticate all requests (OAuth2 client credentials) and use https://api.carerix.io/graphql/v1 as the base URL. Send GraphQL requests as POST /graphql with a JSON body of \{ "query": "...", "variables": \{ ... \} \}.
CEGID TalentSoft Customer talentsoftcustomer/v1 Cegid Talentsoft Recruiting FrontOffice API: API Documentation We automatically authenticate all requests and use https://\{customer_subdomain\}.talent-soft.com/api/v1 as the base URL.
CEGID TalentSoft FrontOffice talentsoft/v2 Cegid Talentsoft Recruiting FrontOffice API. We automatically authenticate all requests using the provided credentials and use https://\{domain\}/api/v2 as the base URL.
Ceipal ceipal/v1 We use https://api.ceipal.com/v1 as the base URL. Find the official docs here.
Cezanne HR cezannehr/dataservice CezanneHR's v7 dataservice API.We automatically authenticate all requests and use the base URL https://\{subdomain\}.cezanneondemand.com/cezanneondemand/v7/dataservice.svc
Compleet (Persy) compleetpersy/api Compleet Persy REST API. We automatically authenticate all requests and use https://www.germanpersonnel.de/persy/api/v1 as the base URL.
Compleet compleetpitcher/pitcher Compleet's Pitcher API. We automatically authenticate all requests and use the configured base URL.
Connexys By Bullhorn connexys/api Connexy's API. We automatically authenticate all requests and use https://\{connexys_domain\}/ as the base URL.
Cornerstone OnDemand cornerstoneondemand/core-hr Cornerstone's Core HR API. We automatically authenticate all requests using the client ID and secret and use https://\{your_domain\}.csod.com/services/api as the base URL.
Cornerstone OnDemand cornerstoneondemand/learning Cornerstone's Learning API. We automatically authenticate all requests using the client ID and secret and use https://\{your_domain\}.csod.com/services/api as the base URL.
Cornerstone OnDemand cornerstoneondemand/recruiting Cornerstone's Recruiting API. We automatically authenticate all requests using the client ID and secret and use https://\{your_domain\}.csod.com/services/api as the base URL.
Cornerstone TalentLink cornerstonetalentlink/apply Cornerstone TalentLink's Apply API. We automatically authenticate all requests using the provided credentials and API key, and use https://apiproxy.shared.lumessetalentlink.com/apply as the base URL.
Cornerstone TalentLink cornerstonetalentlink/rest Cornerstone TalentLink's REST API. We automatically authenticate all requests using the provided credentials and API key, and use https://apiproxy.shared.lumessetalentlink.com/tlk/rest as the base URL.
Coursera coursera/v1 We use https://api.coursera.com/ent as the base URL. Find the official docs here.
Coveto (legacy SOAP API) coveto/public We automatically use https://\{subdomain\}.coveto.de as the base URL.
Coveto (REST API) covetorest/v1 We automatically use https://\{subdomain\}.coveto.de/public/api/v1 as the base URL. https://demo.coveto.de/swagger-ui/index.html#/
Crelate crelate/api Crelate REST API. We automatically authenticate all requests and use https://app.crelate.com/api3 as the base URL.
d.vinci admin dvinciadmin/odata-api DVinci ODATA API.
d.vinci admin dvinciadmin/rest-api DVinci REST API.
d.vinci dvinci/apply-api The DVinci Apply API. All requests are authenticated by Kombo and use https://\{dvinci_domain\}/p/\{portal_path\}/ as the base URL.
d.vinci dvinci/rest-api The DVinci REST API. All requests are authenticated by Kombo and use https://\{dvinci_domain\}/restApi/ as the base URL.
Databites databites/v1 We use https://\{subdomain\}.databites.de as the base URL. Find the official docs here.
DATEV LODAS datev/eau DATEV's eau API. We automatically authenticate all requests and use `https://eau.api.datev.de/\{platform
DATEV datevhr/eau DATEV's eau API. We automatically authenticate all requests and use `https://eau.api.datev.de/\{platform
DATEV datevhr/hr-exports DATEV's hr-exports. We automatically authenticate all requests and use `https://hr-exports.api.datev.de/\{platform
DATEV datevhr/hr:payrollreports DATEV's hr:payrollreports API. We automatically authenticate all requests and use `https://hr-payrollreports.api.datev.de/\{platform
DATEV datevlauds/lauds DATEV's hr-exchange. We automatically authenticate all requests and use `https://hr-exchange.api.datev.de/\{platform
Dayforce dayforce/V1 Dayforce's API. We automatically authenticate all requests and use \{\{baseUrl\}\}/Api/\{\{clientNamespace\}\}/V1 as the base URL
Deel deel/api Deel's API. We automatically authenticate all requests using the provided credentials and use https://\{api_domain\}/rest as the base URL.
Digital Recruiters digitalrecruiters/api Cegid Digital Recruiters Talent Acquisition API. We automatically authenticate all requests by replacing :token in the request URL with your configured access token and use your configured Digital Recruiters domain as the base URL.
Docebo docebo/api Docebo API. We automatically handle authentication and use https://\{subdomain\}.docebosaas.com as the base URL.
Eightfold eightfold/api Eightfold's API. We automatically authenticate all requests and use https://apiv2.\{region\}/api/v2/core/ as the base URL.
Employment Hero employmenthero/default EmploymentHero API. We automatically authenticate all requests using the credentials supplied by the customer and use https://api.employmenthero.com/api as the base URL.
Emply People emplypeople/v2 We use https://api.emply.com/v2 as the base URL. Find the official docs here.
Eploy eploy/api Eploy's API. We automatically authenticate all requests. The base URL is https://\{hostname\}/api, where \{hostname\} is either \{subdomain\}.eploy.net or your full custom hostname when applicable.
eRecruiter erecruiter/api eRecruiter's API. We automatically authenticate all requests and use https://\{domain\}/Api as the base URL.
Eurécia eurecia/api Eurécia REST API We automatically authenticate all requests and use https://\{domain\}/eurecia/rest as the base URL.
Factorial factorial/api Factorial's API. We automatically authenticate all requests and use https://api.factorialhr.com/api or https://api.demo.factorial.dev/api as the base URL, depending on the connected instance.
Flatchr flatchr/api Flatchr's API. We automatically authenticate all requests and use https://api.flatchr.io as the base URL.
Flatchr flatchr/career Flatchr's Career API. We automatically authenticate all requests and use https://career.flatchr.io as the base URL.
Fountain fountain/v2 Fountain's Hire API. We automatically authenticate all requests. The base URL depends on how the integration is connected: Fountain One (OAuth) requests go to https://services.fountain.com/api/servicehire/v2, while legacy API-key requests go to https://\{subdomain\}.fountain.com/api/v2.
Fourth fourth/uk-employee Fourth UK Employee API We automatically authenticate all requests and use https://api.fourth.com/hr/organisations/\{organisation_id\}/ as the base URL. We also enforce the required query params for all requests.
Gem gem/api Gem's ATS API We automatically authenticate all requests and use https://api.gem.com/ats/v0 as the base URL.
Google Workspace googleworkspace/admin Googles's API. We automatically authenticate all requests and use 'https://admin.googleapis.com' as the base URL.
Google Workspace googleworkspace/people Googles's API. We automatically authenticate all requests and use 'https://people.googleapis.com' as the base URL.
Greenhouse (V1) greenhouse/harvest-v2 Greenhouse Harvest API v2. We automatically authenticate all requests using the API key and use https://harvest.greenhouse.io/v2 as the base URL.
Greenhouse (V1) greenhouse/harvest Greenhouse Harvest API v1. We automatically authenticate all requests using the API key and use https://harvest.greenhouse.io/v1 as the base URL.
Greenhouse (V3) greenhousev3/auth We use https://auth.greenhouse.io as the base URL. Find the official docs here.
Greenhouse (V3) greenhousev3/harvestv3 We use https://harvest.greenhouse.io/v3 as the base URL. Find the official docs here.
Greenhouse Job Board greenhousejobboard/boards-api Greenhouse Job Board API. We automatically authenticate all requests and use 'https://boards-api.greenhouse.io/v1/boards/\{job_board_token\}' as the base URL. Optionally, you can provide a custom job_board_token to use a different job board.
Greenhouse greenhouse/harvest-v2 Greenhouse Harvest API v2. We automatically authenticate all requests using the API key and use https://harvest.greenhouse.io/v2 as the base URL.
Greenhouse greenhouse/harvest Greenhouse Harvest API v1. We automatically authenticate all requests using the API key and use https://harvest.greenhouse.io/v1 as the base URL.
Greenhouse greenhouse/harvestv3 We use https://harvest.greenhouse.io/v3 as the base URL. Find the official docs here.
GuideCom guidecom/api GuideCom's API. We automatically authenticate all requests and use the configured API base URL.
Gusto gusto/v1 Gusto API. We automatically authenticate all requests with OAuth and use \{api_base_url\}/v1 as the base URL (https://api.gusto.com/v1 in production, https://api.gusto-demo.com/v1 in development).
Hailey HR haileyhr/api Hailey HR's API. We automatically authenticate all requests using the provided credentials and use https://api.haileyhr.app as the base URL. Connections created against the DEMO remote environment are routed to https://api.demo.haileyhr.app instead.
Hansalog hansalog/vision Hansalog's Vision API. We automatically authenticate all requests and use https://\{subdomain\}.hansalog-cloud.de/vision as the base URL.
Haufe Umantis umantis/v1 Umantis API v1. We automatically authenticate all requests and use https://\{subdomain\}.umantis.com/api/v1 as the base URL.
HeavenHR heavenhr/v2 HeavenHR API. We automatically authenticate all requests using the provided credentials and use https://api.heavenhr.com/api/v2 as the base URL.
Heyrecruit heyrecruit/v2 Heyrecruit's v2 API. We automatically authenticate all requests using the client ID and secret and use https://app.heyrecruit.de/api/v2 as the base URL.
HiBob hibob/docs This passthrough is only used for fetching employee documents in HiBob. It is present as a workaround while we are working on a new endpoint for fetching documents in HRIS. It should not be used for any other purpose. We automatically authenticate all requests using the service user credentials and use https://app.hibob.com/api/docs/employees/ as the base URL.
HiBob hibob/hire HiBob's Hire API. We automatically authenticate all requests using the hire service user credentials. The base URL is configured during the integration setup.
HiBob hibob/v1 HiBob's v1 API. We automatically authenticate all requests using the service user credentials (or, for old integrations, the API key) and use https://api.hibob.com/v1 as the base URL.
HoorayHR hoorayhr/api HoorayHR API. We automatically authenticate all requests and use https://api.hoorayhr.io as the base URL.
HR Office hroffice/soap HROffice SOAP API. We automatically authenticate all requests and wrap them in a SOAP envelope. Build the request Body with the raw XML parameters for your operation (e.g., \<languageId\>1\</languageId\>). Use / as your path. Set your method to POST. You need to specify the api_options object and set operation_name to the SOAP operation you want to call (e.g., GetAllJobByLanguage).
HR WORKS hrworks/v2 HRWorks's v2 API. We automatically authenticate all requests using the customer credentials.
HR WORKS hrworks/v3 HRWorks's v3 API, which covers wage and salary data. We automatically authenticate all requests using the customer credentials.
HR4YOU hr4you/v2 HR4YOU's v2 API. We automatically authenticate all requests and use the customers provided base URL (e.g. https://your-company.hr4you.org/ or a custom domain).
Humaans humaans/api Humaans' API. We automatically authenticate all requests using the API key and use https://app.humaans.io/api as the base URL.
iCIMS icims/default iCIMS Default API. We automatically authenticate all requests and use https://api.icims.com/customers/\{customer_id\} as the base url.
InRecruiting by Zucchetti inrecruiting/default inRecruiting's v3 API. We automatically authenticate all requests and use the customers domain as base URL
Insperity insperity/api Insperity APIs We automatically authenticate all requests and use https://api.insperity.com as the base URL. For staging environments, we use https://apistage.insperity.com. Note that all requests require the company ID to be specified in the path or body.
IRIS Cascade iriscascade/v2 IRIS Cascade HR API. We automatically authenticate all requests using the provided credentials and use https://api.iris.co.uk/hr/v2 as the base URL.
JazzHR jazzhr/v1 JazzHR's v1 API.We automatically authenticate all requests and use "https://api.resumatorapi.com/v1/" as the base URL.
JobAdder jobadder/api We use https://api.jobadder.com/v2 as the base URL. Find the official docs here.
JobDiva jobdiva/api We automatically authenticate all requests and use https://api.jobdiva.com as the base URL.
Jobvite jobvite/api We automatically authenticate all requests and use 'https://api.jobvite.com/api/v2' as the base URL.
Jobvite jobvite/v2 We use https://api.jobvite.com/api/v2 as the base URL. Find the official docs here.
Jobylon jobylon/feed The Jobylon Feed API. We automatically authenticate all requests and use https://\{subdomain\}.jobylon.com/feeds/\{job_hash\} as the base URL.
Jobylon jobylon/push The Jobylon Push API. We automatically authenticate all requests and use https://\{subdomain\}.jobylon.com/p1 as the base URL.
JOIN join/v2 Join's V2 API. We automatically authenticate all requests and use https://api.join.com/v2 as the base URL.
Kenjo kenjo/api Kenjo's API. We automatically authenticate all requests using the API key. The base URL is https://api.kenjo.io/ (or https://sandbox-api.kenjo.io/ for sandbox environments).
Kula kula/v1 Kula's REST API. We automatically authenticate all requests with the provided credentials and use https://api.kula.ai/v1 as the base URL.
Lattice Talent latticetalent/talent Lattice's Talent API. We automatically authenticate all requests using API key credentials with https://api.latticehq.com as the base URL.
Lattice lattice/passthrough Lattice's API. We automatically authenticate all requests using OAuth credentials with https://api.latticehq.com as the base URL.
Lattice lattice/talent Lattice's Talent API. We automatically authenticate all requests using OAuth credentials with https://api.latticehq.com as the base URL.
Laura laura/api We automatically authenticate all requests and use https://\{subdomain\}.rekrytointi.com/api/v1.2 as the base URL.
Leapsome leapsome/scim Leapsome SCIM API. We automatically authenticate all requests using the credentials supplied by the customer and use https://api.leapsome.com/scim/v1 as the base URL.
Leapsome leapsome/v1 Leapsome API. We automatically authenticate all requests using the credentials supplied by the customer and use https://api.leapsome.com/v1 as the base URL.
Lever lever/v1 Lever's v1 API. We automatically authenticate all requests using the partner credentials which have been configured in the Lever tool settings (this uses Kombo's partner credentials by default).
LinkedIn Learning linkedinlearning/v2 LinkedIn Learning API v2. We automatically handle authentication and use https://api.linkedin.com/v2 as the base URL.
Logic Melon logicmelon/json We use https://api.logicmelon.co.uk as the base URL. Find the official docs here.
Loket loket/api Loket's REST API. We automatically authenticate all requests and use https://\{api_domain\} as the base URL, where api_domain is the API domain configured during integration setup (e.g. api.loket.nl).
Loxo loxo/v1 Loxo's API. We automatically authenticate all requests and use 'https://app.loxo.co/api/\{agency_slug\}' as base URL.
Lucca lucca/api Luccas's API. We automatically authenticate all requests and use 'https://{account}.{ilucca
Manatal manatal/career-page Manatal's Career Page API. We use https://api.manatal.com/open/v3/career-page/\{client_slug\} as the base URL.
Manatal manatal/open-api-v3 Manatal's Open API v3. We automatically authenticate all requests and use https://api.manatal.com/open/v3 as the base URL.
Mercury mercury/v1 Mercury's V1 API. We automatically authenticate all requests with the subscription-key and tenant-id headers and use the configured server URL with /api/v1 as the base URL.
Mercury mercury/v2 Mercury's V2 API. We automatically authenticate all requests with the subscription-key and tenant-id headers and use the configured server URL with /api/v2 as the base URL.
Mercury mercury/v3 Mercury's V3 API. We automatically authenticate all requests with the subscription-key and tenant-id headers and use the configured server URL with /api/v3 as the base URL.
MHR People First peoplefirst/v1 MHR People First v1 API. We automatically authenticate all requests using the access token and tenant/environment codes. For default environments, we use https://\{tenant_code\}.people-first.com/api/v1 as the base URL. For non-default environments, we use https://\{tenant_code\}-\{environment_code\}.people-first.com/api/v1.
Microsoft Azure AD azuread/v1 AzureAD's API. We automatically authenticate all requests.
Microsoft Entra ID entraid/v1 AzureAD's API. We automatically authenticate all requests.
Moodle moodle/rest Moodle REST Web Services API. All calls go to /webservice/rest/server.php with wsfunction and wstoken parameters. We automatically handle authentication and use \{site_url\}/webservice/rest/server.php as the base URL.
Mysolution mysolution/default Mysolution's API. We automatically authenticate all requests and use the customer's domain as base URL.
Nmbrs nmbrs/soap Nmbrs SOAP API. We automatically authenticate all requests and use https://api.nmbrs.nl/soap/v3/ as the base URL. Set data to your raw XML string (the content that will be placed inside the \<soap:Body\> tag). Use / as your path, as we will always send requests to https://api.nmbrs.nl/soap/v3/\{service_name\}.asmx. Set your method to POST. You need to specify the api_options object and set service_name to the name of the service you want to call. Available services include EmployeeService, CompanyService, and DebtorService.
Odoo odoo/json2 Odoo's JSON-2 API. We automatically authenticate all requests and use https://\{domain\}.odoo.com/json/2 as the base URL. Odoo JSON-2 requests are always POST requests and use paths like /\{model\}/\{method\} (e.g. /res.partner/search_read).
Okta okta/v1 Okta's API. We automatically authenticate all request ans use 'https://<your-okta-domain>/api/v1' as the base URL.
Onlyfy onlyfy/v1 Onlyfy's Public v1 REST API. We automatically authenticate all requests using the apikey header and use https://api.prescreenapp.io/v1 as the base URL.
Oracle HCM oraclehcm/api Oracle HCM Cloud REST API. We automatically authenticate all requests and use https://\{domain\}/ as the base URL, where domain is your Oracle Cloud domain.
Oracle Recruiting Cloud oraclerecruiting/rest Oracle's REST API. We automatically authenticate all requests and use 'https://{company_url}' as the base url.
Oracle Recruiting Cloud oraclerecruiting/rest Oracles's REST API. We automatically authenticate all requests and use 'https://{company_url}' as the base url.
Oracle Taleo taleo/soap Taleo's API. We automatically authenticate all requests and use 'https://{your-subdomain}.taleo.net/enterprise/soap' as base URL.
OTYS otys/json-rpc OTYS JSON-RPC API. We authenticate with your stored API key and inject the session token as the first element of the JSON-RPC params array on each request (except loginByUid, which uses params as sent). Requests use https://ows.otys.nl as the base URL (for example POST /jservice.php with the RPC method in the URL fragment, matching OTYS conventions).
PageUp People pageup/v1 We use https://assessment-mock-api.dc0.pageuppeople.com as the base URL. Find the official docs here.
PageUp People pageup/v3 We use https://\<environment\>.\<dataCentreId\>.pageuppeople.com/v3/\<tenantId\>/recruitment as the base URL. Find the official docs here.
Paradox paradox/v1 We use \{api_url\}/api/v1 as the base URL. Find the official docs here.
Paradox paradox/v1public We use \{api_url\}/api/v1/public as the base URL. Find the official docs here.
Paychex paychex/api Paychex REST API. We automatically authenticate all requests and use https://api.paychex.com as the base URL.
Paycom paycom/v1 Paycom's REST API. We automatically authenticate all requests using the provided SID and API Token and use https://api.paycomonline.net/v4/rest/index.php/api/v1 as the base URL.
Paycor paycor/v1 Paycors's v1 API. We automatically authenticate all requests and use 'https://apis.paycor.com'.
PayFit payfitcustomer/api PayFit Partner API. We automatically authenticate all requests using the provided API key and use https://partner-api.payfit.com as the base URL.
PayFit payfitpartner/partner-api PayFit Partner API. We automatically authenticate all requests using the OAuth access token and use https://partner-api.payfit.com as the base URL.
Paylocity paylocity/default Paylocity's Weblink API. We automatically authenticate all requests and use 'https://{api
Paylocity paylocity/next-gen Paylocity's NextGen API. We automatically authenticate all requests and use 'https://dc1prodgwext.paylocity.com/' as the base URL.
PeopleHR peoplehr/default PeopleHR's API. We automatically authenticate all request ans use 'https://api.peoplehr.net' as the base URL.
PeopleXD peoplexd/b2b PeopleXD's B2B API. We automatically authenticate all requests and use https://api.corehr.com/ws/\{tenant_id\}/corehr or https://uatapi.corehr.com/ws/\{tenant_id\}/corehr as the base URL.
Personio personio/jobboard API endpoints exposed on Personio's public job board pages (currently just the XML feed). We automatically use the right https://\{company\}.jobs.personio.de base URL.
Personio personio/personnel Personio's Personnel Data API. We automatically authenticate all requests using the client ID and secret and use https://api.personio.de/v1 as the base URL.
Personio personio/personnelv2 Personio's V2 Personnel Data API. We automatically authenticate all requests using the client ID and secret and use https://api.personio.de/v2 as the base URL.
Personio personio/recruiting Personio's Recruiting API. We automatically authenticate all requests using the Recruiting access token and use https://api.personio.de/v1/recruiting as the base URL.
Personio personio/recruitingV2 Personio's V2 Recruiting API. We automatically authenticate all requests using the Recruiting access token, send the Beta header and use https://api.personio.de/v2/recruiting as the base URL.
Phenom phenom/rest-api The Phenom API. We automatically authenticate all requests and use https://api-stg.phenompro.com as the base URL.
Pinpoint pinpoint/v1 Pinpoint's JSON:API. We automatically authenticate all requests using the X-API-KEY header and use https://\{subdomain\}.pinpointhq.com/api/v1 as the base URL.
Planday planday/api Planday's HR API v1.0. We automatically authenticate all requests and use https://openapi.planday.com as the base URL.
ReachMee reachmee/reachmee ReachMee API. We automatically authenticate all requests and use https://api.talentech.io/reachmee/ as the base URL.
Recruit CRM recruitcrm/api We use https://api.recruitcrm.io as the base URL. Find the official docs here.
RecruiterFlow recruiterflow/v1 RecruiterFlow API docs. We automatically authenticate all requests using the RF-Api-Key header and use https://api.recruiterflow.com as the base URL.
Remote remotecom/default Remote's API. We automatically authenticate all requests using provided credentials. The base URL is https://gateway.remote.com/v1 for production API keys (prefixed ra_live_), or https://gateway.remote-sandbox.com/v1 for sandbox API keys.
rexx systems rexx/default Rexx's HRIS export API. There is only one endpoint: Get /
Rippling rippling/api Rippling's API. We automatically authenticate all requests and use https://api.rippling.com/platform/api orhttps://rest.ripplingapis.com as the base URL.
Sage HR sagehr/api Sage HR's API. We automatically authenticate all requests and use https://\{subdomain\}.sage.hr/api as the base URL.
Sage People sagepeople/salesforce-rest-api Sage People is built on Salesforce's API. We automatically authenticate all requests and use https://\{customer_name\}.my.salesforce.com/ as the base URL.
SAP SuccessFactors successfactors/lms-odata-v4 We use https://\{api_domain\}/learning/odatav4 as the base URL. Find the official docs here.
SAP SuccessFactors successfactors/odata-v2 SuccessFactors' OData V2 API. We automatically authenticate all requests and use https://\{api_domain\}\{path?\}/odata/v2 as the base URL (the optional \{path\} is used when connecting via proxied/gateway domains).
SD Worx sdworx/default SD Worx's OData API. We automatically authenticate all requests using the client ID and secret and use \{api_url\} as the base URL.
Silae silae/rest Silae's REST API. We automatically authenticate all requests and use 'https://payroll-api.silae.fr/payroll' as the base URL.
Simployer simployer/v1 AlexisHR's v1 API We automatically authenticate all requests and use https://\{subdomain\}.alexishr.com as base URL.
Skello skello/svcemployees Skello's Service Employees API. We automatically authenticate all requests and use https://svc-employees.skello.io as the base URL. We also fill in the required organisationId query param, which is derived from your API key.
Skello skello/svcpunch Skello's Service Punch API. We automatically authenticate all requests and use https://svc-punch.skello.io as the base URL.
Skello skello/svcshops Skello's Service Shops API. We automatically authenticate all requests and use https://svc-shops.skello.io as the base URL. We also fill in the required organisationId query param, which is derived from your API key.
SmartRecruiters smartrecruiters/default Smartrecruiters API. We automatically authenticate all requests using OAuth and use https://api.smartrecruiters.com as the base URL.
SmartRecruiters smartrecruiters/default Smartrecruiters API. We automatically authenticate all requests using the credentials supplied by the customer and use https://api.smartrecruiters.com as the base URL.
Softgarden softgarden/apply-api Softgarden's Apply API. We automatically authenticate all requests and use 'https://jobdb.softgarden.de/jobdb/public' as base URL.
Softgarden softgarden/frontend-v3 [Softgarden's Frontend API v3](https://dev.softgarden.de/frontend-v3/. We automatically authenticate all requests and use 'https://api.softgarden.io/api/rest' as base URL.
Spark Hire Recruit comeet/api Spark Hire Recruit's API.We automatically authenticate all requests and use https://api.comeet.com as the base URL.
Spott spott/protected The Spott API. We automatically authenticate all requests and use https://api.gospott.com as the base URL.
Sympa sympa/api Sympa's API. We automatically authenticate all requests and use https://api.sympahr.net/api/ as the base URL.
Taleez taleez/0 Taleez's API. We automatically authenticate all requests and use https://api.taleez.com/0 as the base URL.
Talent360 talent360/v3 We use https://api.talent360.io/V3 as the base URL. Find the official docs here.
Talention talention/v1 Talention's API. We automatically authenticate all requests and use https://\{api_domain\}/tms/\{account_id\}/external/api/1.0 as the base URL. Documentation is provided privately by Talention. Contact Kombo support for assistance with specific endpoints.
TalentLMS talentlms/v2 We use https://\{subdomain\}.talentlms.com/api/v2 as the base URL.
Teamtailor Job Boards teamtailorjobboards/direct-apply Teamtailor's Job Board Direct Apply API. We automatically authenticate all requests and use https://5qbn6o9x4h.execute-api.eu-west-1.amazonaws.com/production as the base URL. All requests are automatically signed with HMAC-SHA256 signature.
Teamtailor teamtailor/v1 We use https://api.teamtailor.com/v1 as the base URL. Find the official docs here.
Tellent Recruitee recruitee/default The Recruitee API. We automatically authenticate all requests and use https://api.recruitee.com/c/\{company_id\} as the base URL.
Tellent Recruitee recruitee/v1 We use https://api.recruitee.com/c/\{company_id\} as the base URL. Find the official docs here.
TrackerRMS trackerrms/v1 We use https://evousapi.tracker-rms.com as the base URL. Find the official docs here.
TRAFFIT traffit/v2 Traffit's v2 API. We authenticate all requests with the Traffit API key and use the base URL https://yourdomain.traffit.com/api/integration/v2.
TriNet PEO trinetpeo/v1 We use https://api.trinet.com as the base URL. Find the official docs here.
Ubeeo ubeeo/api Ubeeo ATS API. We automatically authenticate all requests using OAuth client credentials and use https://api.ats-platform.com as the base URL (sandbox: https://api.acc.ats-platform.com).
Udemy Business udemy/learning Udemy Business REST API. We automatically handle authentication and use https://\{account_name\}.udemy.com/api-2.0/organizations/\{account_id\}/ as the base URL.
UKG Pro WFM ukgprowfm/api UKG Pro WFM's API. We automatically authenticate all requests and use https://\{hostname\} as the base URL.
UKG Pro ukgpro/default UKG Pro's HRIS API. We automatically authenticate all requests and use https://\{hostname\} as the base URL.
UKG Pro ukgpro/recruting UKG Pro's Recruiting API. We automatically authenticate all requests and use https://\{hostname\}/talent/recruiting/v2/\{tenantalias\}/api as the base URL.
UKG Ready ukgready/api UKG Ready API. We automatically authenticate all requests using the provided credentials and use https://\{api_domain\} as the base URL.
Visma Peple peple/hrm Visma Payroll Reporting API. We automatically authenticate all requests using the client credentials and use 'https://api.analytics1.hrm.visma.net' as the base URL.
Visma Raet - Youforce youforce/v1.0 Youforce's basic v1.0 API. We automatically authenticate all requests and use 'https://api.youforce.com' as base URL.
Visma YouServe youserve/learning Visma YouServe Learning API. We automatically authenticate all requests using OAuth 2.0 with the provided credentials and use https://api.youserve.nl/learning/v1.0 as the base URL.
Workable workable/v1 Deprecated: Use v3 instead. Workable's API. We automatically authenticate all requests using the client ID and secret and use https://\{subdomain\}.\{environment\}.com/spi/v3 as the base URL.
Workable workable/v3 Workable's API. We automatically authenticate all requests using the client ID and secret and use https://\{subdomain\}.\{environment\}.com/spi/v3 as the base URL.
Workday workday/custom-report Workday's Custom Reports. We automatically authenticate all requests and use https://\{domain\}/ccx/service/customreport2/\{tenant\}/ as the base URL. Set your method to GET. The path should be the report path after the tenant, e.g., /\{report_owner\}/\{report_name\}. You can include query parameters in the params object (e.g., format=json).
Workday workday/rest Workday's REST API. We automatically authenticate all requests and use the correct Workday REST base URL for your tenant. The base URL follows the format: https://{domain}/api/{service_name}/{version}/{tenant}. You can specify any valid REST endpoint and method. See the Workday REST API documentation for available endpoints. You must specify the api_options object and set service_name to the name of the service you want to call. You can also specify the version (e.g., "v1", "v2"); if omitted, it defaults to "v1".
Workday workday/soap Workday's SOAP API. We automatically authenticate all requests. Set data to your raw xml string. Use / as your path, as we will always send requests to https://\{domain\}/ccx/service/\{tenant\}/\{service_name\}. Set your method to POST. You need to specify the api_options object and set service_name to the name of the service you want to call. Find all available services here. The string that you submit as data will be the content of the soapenv:Body tag in the request. You can set the service_version to any valid Workday service version (the default is 38.2).
workforce.com workforcecom/api Workforce.com API. We automatically authenticate all requests using the provided credentials and use https://my.tanda.co as the base URL.
Zellis zellis/api Zellis Intelligence Platform OData API. We automatically authenticate all requests using the provided credentials and use https://api.hcm.zellis.com/\{customer_code\}/external/odata/v1 as the base URL.
Zelt zelt/partner Zelt's Partner API. We automatically authenticate all requests using the connected OAuth credentials and use https://go.zelt.app/apiv2/partner as the base URL.
Zoho Recruit zohorecruit/v2 Zoho Recruit's V2 API. We automatically authenticate all requests and use https://recruit.\{domain\}/recruit/v2 as the base URL.
Zvoove Recruit zvooverecruit/applicants Zvoove Recruit's Applicants API. We automatically authenticate all requests using the applicants API key and use 'https://{domain}/api/public' as base URL.
Zvoove Recruit zvooverecruit/jobs Zvoove Recruit's Jobs API. We automatically authenticate all requests using the jobs API key and use 'https://{domain}/api/public' as base URL.

Please note that the passthrough API endpoints are only meant for edge cases. That's why we only expose them for new integrations after understanding a concrete customer use case. If you have such a use case in mind, please reach out to Kombo.

Example Usage: Error Response

from kombo import Kombo


with Kombo(
    integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.send_passthrough_request(tool="<value>", api="<value>", method="DELETE", path="/private/var")

    # Handle response
    print(res)

Example Usage: Minimal Error Response

from kombo import Kombo


with Kombo(
    integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.send_passthrough_request(tool="<value>", api="<value>", method="DELETE", path="/private/var")

    # Handle response
    print(res)

Example Usage: example1

from kombo import Kombo


with Kombo(
    integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.send_passthrough_request(tool="personio", api="personnel", method="GET", path="/company/employees")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
tool str ✔️ The ID of the tool whose passthrough API you want to call (e.g., personio).
api str ✔️ 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.
method models.Method ✔️ The HTTP method (e.g., GET) of the request.
path str ✔️ The path of the endpoint you want to call. We automatically prepend the base URL of the API (all base URLs are documented in the endpoint description).
headers Dict[str, str] ➖ The headers to send with the request. Note that we automatically supply any authentication-related headers.
params Dict[str, str] ➖ The query parameters to send in addition to the ones in the path.
data Optional[Any] ➖ The data to submit as part of the request body. This can either be an array or object (in which case we will forward it as JSON) or a string (in which case we will forward it raw).
response_as_base64 Optional[bool] ➖ If set to true, the response will be returned as a base64-encoded string. This is useful for binary data (e.g., PDFs).
multipart_form_data List[models.MultipartFormDatum] ➖ N/A
api_options Dict[str, str] ➖ Custom options interpreted by the passthrough API adapter you've selected. These options are not documented right now as they're only for very advanced use cases.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.PostPassthroughToolAPIPositiveResponse

Errors

Error Type Status Code Content Type
errors.KomboGeneralError default application/json
errors.SDKDefaultError 4XX, 5XX */*

delete_integration

Delete the specified integration. ⚠️ This can not be undone!

Example Usage: Error Response

from kombo import Kombo


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.delete_integration(integration_id="<id>", body={})

    # Handle response
    print(res)

Example Usage: Minimal Error Response

from kombo import Kombo


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.delete_integration(integration_id="<id>", body={})

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
integration_id str ✔️ DELETE /integrations/:integration_id Parameter
body models.DeleteIntegrationsIntegrationIDRequestBody ✔️ DELETE /integrations/:integration_id Request body
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.DeleteIntegrationsIntegrationIDPositiveResponse

Errors

Error Type Status Code Content Type
errors.KomboGeneralError default application/json
errors.SDKDefaultError 4XX, 5XX */*

get_integration_details

Get the specified integration with everything you need to display it to your customer.

Example Usage

from kombo import Kombo


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.get_integration_details(integration_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
integration_id str ✔️ GET /integrations/:integration_id Parameter
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.GetIntegrationsIntegrationIDPositiveResponse

Errors

Error Type Status Code Content Type
errors.KomboGeneralError default application/json
errors.SDKDefaultError 4XX, 5XX */*

set_integration_enabled

Enable or disable the specified integration. When disabling, all currently running syncs will be cancelled.

All authentication credentials and configuration are preserved. Syncs can be resumed by re-enabling the integration.

You may use this to, for example, pause syncing for customers that are temporarily not using the integration.

Example Usage: Error Response

from kombo import Kombo


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.set_integration_enabled(integration_id="<id>", value=False)

    # Handle response
    print(res)

Example Usage: Minimal Error Response

from kombo import Kombo


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.set_integration_enabled(integration_id="<id>", value=False)

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
integration_id str ✔️ PUT /integrations/:integration_id/enabled Parameter
value bool ✔️ The desired state of the integration (e.g., true for enabled, false for disabled).
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.PutIntegrationsIntegrationIDEnabledPositiveResponse

Errors

Error Type Status Code Content Type
errors.KomboGeneralError default application/json
errors.SDKDefaultError 4XX, 5XX */*

create_reconnection_link

Create a link that will allow the user to reconnect an integration. This is useful if you want to allow your users to update the credentials if the old ones for example expired.

Embed this the same way you would embed the connect link. By default, the link will be valid for 1 hour.

Example Request Body

{
  "language": "en",
  "scope_config_id": "9Pv6aCFwNDEzPNmwjSsY9SQx",
  "link_type": "EMBEDDED"
}

Example Usage: Error Response

from kombo import Kombo


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.create_reconnection_link(integration_id="<id>", language="en", link_type="EMBEDDED")

    # Handle response
    print(res)

Example Usage: Minimal Error Response

from kombo import Kombo


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.create_reconnection_link(integration_id="<id>", language="en", link_type="EMBEDDED")

    # Handle response
    print(res)

Example Usage: example1

from kombo import Kombo


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.create_reconnection_link(integration_id="personio:93fCvorjZ2jas7ZekX1V1n5d", language="en", scope_config_id="9Pv6aCFwNDEzPNmwjSsY9SQx", link_type="EMBEDDED")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
integration_id str ✔️ POST /integrations/:integration_id/relink Parameter
language OptionalNullable[models.PostIntegrationsIntegrationIDRelinkRequestBodyLanguage] ➖ Language of the connection flow UI.
scope_config_id OptionalNullable[str] ➖ Specify a scope config which the integration will start using once the reconnection flow has been completed.

This can be useful if you want to update the permissions of an integration, but only want the change to take effect once the user has updated their API credentials to prevent sync issues.
link_type Optional[models.PostIntegrationsIntegrationIDRelinkRequestBodyLinkType] ➖ The type of link you want to create. EMBEDDED is for the embedded flow using the Kombo Connect SDK (these links are valid for 1 hour) and MAGIC_LINK is for magic links which you send out manually to customers (there are valid for 1 year).

This defaults to EMBEDDED, which is our recommended method of implementing the connection flow for a seamless user experience.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.PostIntegrationsIntegrationIDRelinkPositiveResponse

Errors

Error Type Status Code Content Type
errors.KomboGeneralError default application/json
errors.SDKDefaultError 4XX, 5XX */*

create_setup_link

Create a link that lets your customer run the Setup Flow for an integration. Use this to send customers back into setup steps like field mapping or employee filtering without having to go through the initial connection flow again. Pass the returned URL to showKomboConnect from the Kombo Connect SDK, the same way you do with a connection link.

The integration must have at least one Setup Flow step enabled (e.g. field mapping or employee filtering); otherwise this endpoint returns a PLATFORM.INPUT_INVALID error. Steps can be enabled from the Integration Settings tab in the dashboard or via the Create Connection Link endpoint.

Example Usage: Error Response

from kombo import Kombo


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.create_setup_link(integration_id="<id>", link_type="MAGIC_LINK", language="en")

    # Handle response
    print(res)

Example Usage: Minimal Error Response

from kombo import Kombo


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.create_setup_link(integration_id="<id>", link_type="MAGIC_LINK", language="en")

    # Handle response
    print(res)

Example Usage: example1

from kombo import Kombo


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.create_setup_link(integration_id="personio:93fCvorjZ2jas7ZekX1V1n5d", link_type="EMBEDDED", language="en")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
integration_id str ✔️ POST /integrations/:integration_id/setup-link Parameter
link_type models.PostIntegrationsIntegrationIDSetupLinkRequestBodyLinkType ✔️ The type of link you want to create. EMBEDDED is for the embedded flow using the Kombo Connect SDK (these links are valid for 1 hour) and MAGIC_LINK is for magic links which you send out manually to customers (these are valid for 1 year).
language OptionalNullable[models.PostIntegrationsIntegrationIDSetupLinkRequestBodyLanguage] ➖ Language of the setup flow UI.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.PostIntegrationsIntegrationIDSetupLinkPositiveResponse

Errors

Error Type Status Code Content Type
errors.KomboGeneralError default application/json
errors.SDKDefaultError 4XX, 5XX */*

get_integration_fields

Get all fields available on the specified integration. This includes the mapping to your custom fields

Example Usage

from kombo import Kombo


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.get_integration_fields(integration_id="<id>", page_size=100)

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter Type Required Description
integration_id str ✔️ GET /integrations/:integration_id/integration-fields Parameter
cursor Optional[str] ➖ An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
page_size Optional[int] ➖ The number of results to return per page. Maximum is 2000.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.GetIntegrationsIntegrationIDIntegrationFieldsResponse

Errors

Error Type Status Code Content Type
errors.KomboGeneralError default application/json
errors.SDKDefaultError 4XX, 5XX */*

update_integration_field

When enabled, the integration field will be passed as part of the integration_fields array on the specific model endpoint. Providing false will disable the passthrough for the specified field.

Example Usage: Error Response

from kombo import Kombo


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.update_integration_field(integration_id="<id>", integration_field_id="<id>", enable_passthrough=None)

    # Handle response
    print(res)

Example Usage: Minimal Error Response

from kombo import Kombo


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.update_integration_field(integration_id="<id>", integration_field_id="<id>", enable_passthrough=None)

    # Handle response
    print(res)

Example Usage: example1

from kombo import Kombo


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.update_integration_field(integration_id="integration_id", integration_field_id="integration_field_id", enable_passthrough=True)

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
integration_id str ✔️ PATCH /integrations/:integration_id/integration-fields/:integration_field_id Parameter
integration_field_id str ✔️ PATCH /integrations/:integration_id/integration-fields/:integration_field_id Parameter
enable_passthrough Nullable[bool] ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.PatchIntegrationsIntegrationIDIntegrationFieldsIntegrationFieldIDPositiveResponse

Errors

Error Type Status Code Content Type
errors.KomboGeneralError default application/json
errors.SDKDefaultError 4XX, 5XX */*

get_custom_fields

Get all custom fields available on the specified integration. *This includes the mapping to the corresponding integration field if applicable

Example Usage

from kombo import Kombo


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.get_custom_fields(integration_id="<id>", page_size=100)

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter Type Required Description
integration_id str ✔️ GET /integrations/:integration_id/custom-fields Parameter
cursor Optional[str] ➖ An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
page_size Optional[int] ➖ The number of results to return per page. Maximum is 250.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.GetIntegrationsIntegrationIDCustomFieldsResponse

Errors

Error Type Status Code Content Type
errors.KomboGeneralError default application/json
errors.SDKDefaultError 4XX, 5XX */*

update_custom_field_mapping

Updates the mapping of a given custom field. If the custom field is already mapped, it will be updated.

Example Usage: Error Response

from kombo import Kombo


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.update_custom_field_mapping(integration_id="<id>", custom_field_id="<id>", integration_field_id="<id>")

    # Handle response
    print(res)

Example Usage: Minimal Error Response

from kombo import Kombo


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.update_custom_field_mapping(integration_id="<id>", custom_field_id="<id>", integration_field_id="<id>")

    # Handle response
    print(res)

Example Usage: example1

from kombo import Kombo


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.update_custom_field_mapping(integration_id="integration_id", custom_field_id="custom_field_id", integration_field_id="integration_field_id")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
integration_id str ✔️ The unique ID of the integration where the custom field mapping should be updated
custom_field_id str ✔️ The unique ID of the custom field that should be updated
integration_field_id Nullable[str] ✔️ The integration field's unique ID which the custom field should be mapped to. Null to remove a mapping.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.PutIntegrationsIntegrationIDCustomFieldsCustomFieldIDPositiveResponse

Errors

Error Type Status Code Content Type
errors.KomboGeneralError default application/json
errors.SDKDefaultError 4XX, 5XX */*

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.

Example Usage

from kombo import Kombo


with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:

    res = k_client.general.get_tools(category="ats")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
category models.GetToolsCategoryParameterCategory ✔️ GET /tools/:category Parameter
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.GetToolsCategoryPositiveResponse

Errors

Error Type Status Code Content Type
errors.KomboGeneralError default application/json
errors.SDKDefaultError 4XX, 5XX */*