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 Custom Endpoints API

Custom integration-specific endpoints.

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

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

This API exposes 18 operations across 18 paths, and defines 37 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.

18 operations 18 paths 37 schemas 1 DELETE7 GET8 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 Custom Endpoints 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 18

Across 18 paths, the API surfaces 18 operations — 1 DELETE, 7 GET, 8 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Custom Endpoints 18

Custom integration-specific endpoints.

POST
/ats/custom/avionte/synced-jobs
Add a job to be synced
PostAtsCustomAvionteSyncedJobs 1 param body → 200default
DELETE
/ats/custom/avionte/synced-jobs/{job_remote_id}
Remove a job from sync
DeleteAtsCustomAvionteSyncedJobsJobRemoteId 2 params body → 200default
GET
/custom/datev/system-information
Get DATEV system information
GetCustomDatevSystemInformation 1 param → 200default
POST
/custom/datev/passthrough
Write raw DATEV ASCII file
PostCustomDatevPassthrough 1 param body → 200default
GET
/custom/datev/check-eau-permission
Verify service is enabled
GetCustomDatevCheckEauPermission 1 param → 200default
GET
/custom/datev/eau-requests/{eau_id}
Query the status of the eAU request
GetCustomDatevEauRequestsEauId 2 params → 200default
GET
/custom/datev/check-document-permission
Verify service is enabled
GetCustomDatevCheckDocumentPermission 1 param → 200default
GET
/custom/datev/available-documents
Retrieve available documents
GetCustomDatevAvailableDocuments 2 params → 200default
POST
/custom/datev/download-document
Download Payroll Document
PostCustomDatevDownloadDocument 1 param body → 200default
POST
/custom/datev/employees/{employee_id}/download-document
Download Payroll Document
PostCustomDatevEmployeesEmployeeIdDownloadDocument 2 params body → 200default
POST
/custom/datev/employees/{employee_id}/eau-requests
Create eAU Request
PostCustomDatevEmployeesEmployeeIdEauRequests 2 params body → 200default
PUT
/custom/datev/employees/{employee_id}/prepare-payroll
Prepare DATEV Payroll
PutCustomDatevEmployeesEmployeeIdPreparePayroll 2 params body → 200default
PUT
/custom/datev/employees/{employee_id}/compensations
Set DATEV compensations
PutCustomDatevEmployeesEmployeeIdCompensations 2 params body → 200default
GET
/custom/datev/check-write-permission
Verify service is enabled
GetCustomDatevCheckWritePermission 1 param → 200default
GET
/custom/datev/data-pushes
Get DATEV data pushes
GetCustomDatevDataPushes 1 param → 200default
POST
/custom/datev/push-data/general
Push general data to DATEV
PostCustomDatevPushDataGeneral 1 param body → 200default
POST
/custom/datev/push-data/payroll
Push payroll data to DATEV
PostCustomDatevPushDataPayroll 1 param body → 200default
POST
/custom/silae/employees/{employee_id}/payroll-supplements
Write Payroll Supplement
PostCustomSilaeEmployeesEmployeeIdPayrollSupplements 2 params body → 200default

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are PostCustomDatevPassthroughRequestBody (5 properties), PostCustomSilaeEmployeesEmployeeIdPayrollSupplementsRequestBody (4 properties), PutCustomDatevEmployeesEmployeeIdPreparePayrollRequestBody (4 properties), PostCustomDatevPushDataPayrollPositiveResponse (3 properties). Each schema is shown below with its type and property counts.

PostCustomDatevPushDataPayrollPositiveResponse
object
3 properties 3 required
GetCustomDatevCheckEauPermissionPositiveResponse
object
3 properties 3 required
GetCustomDatevCheckWritePermissionPositiveResponse
object
3 properties 3 required
PostCustomDatevPassthroughRequestBody
object
5 properties 5 required
PutCustomDatevEmployeesEmployeeIdCompensationsPositiveResponse
object
3 properties 3 required
PostCustomDatevPushDataGeneralPositiveResponse
object
3 properties 3 required
DeleteAtsCustomAvionteSyncedJobsJobRemoteIdParameterJobRemoteId
string
PostCustomDatevPassthroughPositiveResponse
object
3 properties 3 required
PutCustomDatevEmployeesEmployeeIdCompensationsRequestBody
object
2 properties 2 required
PostCustomDatevEmployeesEmployeeIdDownloadDocumentParameterEmployeeId
stringnull
PostCustomDatevEmployeesEmployeeIdEauRequestsPositiveResponse
object
3 properties 3 required
PostCustomDatevEmployeesEmployeeIdEauRequestsRequestBody
object
The data to request an electronic certificate of incapacity for work (eAU).
3 properties 1 required
PostCustomSilaeEmployeesEmployeeIdPayrollSupplementsPositiveResponse
object
3 properties 3 required
PostAtsCustomAvionteSyncedJobsRequestBody
object
1 property 1 required
PostCustomDatevPushDataGeneralRequestBody
object
GetCustomDatevDataPushesPositiveResponse
object
2 properties 2 required
PostCustomDatevPushDataPayrollRequestBody
object
1 property 1 required
PostCustomSilaeEmployeesEmployeeIdPayrollSupplementsParameterEmployeeId
string
ID of the employee that should be updated. You can use their Kombo id or their ID in the remote system by prefixing it with remote: (e.g., remote:12312)
PostCustomDatevEmployeesEmployeeIdDownloadDocumentRequestBody
object
The data to request an electronic certificate of incapacity for work (eAU).
2 properties 2 required
PostCustomDatevDownloadDocumentPositiveResponse
object
3 properties 3 required
GetCustomDatevAvailableDocumentsPositiveResponse
object
3 properties 3 required
DeleteAtsCustomAvionteSyncedJobsJobRemoteIdPositiveResponse
object
2 properties 2 required
PostCustomDatevEmployeesEmployeeIdEauRequestsParameterEmployeeId
string
ID of the employee that should be updated. You can use their Kombo id or their ID in the remote system by prefixing it with remote: (e.g., remote:12312)
PostCustomSilaeEmployeesEmployeeIdPayrollSupplementsRequestBody
object
4 properties 2 required
GetCustomDatevAvailableDocumentsParameterPeriod
string
Provide the period in the format YYYY-MM-DD for which to check for available documents.
GetCustomDatevEauRequestsEauIdPositiveResponse
object
3 properties 3 required
GetCustomDatevEauRequestsEauIdParameterEauId
string
GetCustomDatevSystemInformationPositiveResponse
object
2 properties 2 required
PutCustomDatevEmployeesEmployeeIdPreparePayrollParameterEmployeeId
string
ID of the employee that should be updated. You can use their Kombo id or their ID in the remote system by prefixing it with remote: (e.g., remote:12312)
PostCustomDatevEmployeesEmployeeIdDownloadDocumentPositiveResponse
object
3 properties 3 required
DeleteAtsCustomAvionteSyncedJobsJobRemoteIdRequestBody
object
PutCustomDatevEmployeesEmployeeIdPreparePayrollRequestBody
object
4 properties 3 required
PostCustomDatevDownloadDocumentRequestBody
object
The data to request an electronic certificate of incapacity for work (eAU).
3 properties 3 required
PostAtsCustomAvionteSyncedJobsPositiveResponse
object
2 properties 2 required
PutCustomDatevEmployeesEmployeeIdPreparePayrollPositiveResponse
object
3 properties 3 required
PutCustomDatevEmployeesEmployeeIdCompensationsParameterEmployeeId
string
ID of the employee that should be updated. You can use their Kombo id or their ID in the remote system by prefixing it with remote: (e.g., remote:12312)
GetCustomDatevCheckDocumentPermissionPositiveResponse
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kombo-custom-endpoints-api-openapi.yml Raw ↑

Other APIs Kombo publishes across the network.

Kombo AI Apply API
Kombo General 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