> ## 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.
# Create provisioning setup link (deprecated)
> Create a new link that can be passed to the Kombo Connect SDK to open the provisioning setup UI.
**This endpoint is deprecated!**
Please use the [Create Setup Flow link endpoint](/v1/post-integrations-integration-id-setup-link) instead. It supports the full Setup Flow (including filtering, field mapping, and any other enabled steps) and works for any integration category, not just HRIS.
## OpenAPI
````yaml POST /hris/provisioning-groups/{group_id}/setup-links
openapi: 3.1.0
info:
title: Kombo API
version: 1.0.0
servers:
- url: https://api.kombo.dev/v1
description: Kombo EU API
- url: https://api.us.kombo.dev/v1
description: Kombo US API
security:
- ApiKey: []
tags:
- name: General
- name: Kombo Connect
description: >-
Endpoints for Kombo Connect, our end-user-facing flow for setting up new
integrations.
- name: Unified HRIS API
description: Unified endpoints to access all the HR concepts you might need.
- name: Unified ATS API
description: Unified endpoints to access all the ATS concepts you might need.
- name: Unified ATS (Assessment & Background Check) API
description: >-
Unified endpoints to operate Assessments and Background Checks for many
applicant tracking systems.
- name: Unified LMS API
description: Unified endpoints to access all the LMS concepts you might need.
- name: AI Apply
description: Endpoints for AI-powered job application features.
- name: Custom Endpoints
description: Custom integration-specific endpoints.
paths:
/hris/provisioning-groups/{group_id}/setup-links:
post:
tags:
- Unified HRIS API
summary: Create provisioning setup link (deprecated)
description: >-
Create a new link that can be passed to the Kombo Connect SDK to open
the provisioning setup UI.
**This endpoint is deprecated!**
Please use the [Create Setup Flow link endpoint](/v1/post-integrations-integration-id-setup-link) instead. It supports the full Setup Flow (including filtering, field mapping, and any other enabled steps) and works for any integration category, not just HRIS.
operationId: PostHrisProvisioningGroupsGroupIdSetupLinks
parameters:
- in: header
name: X-Integration-Id
schema:
type: string
description: ID of the integration you want to interact with.
example: bamboohr:HWUTwvyx2wLoSUHphiWVrp28
required: true
- name: group_id
in: path
required: true
description: ID of the provisioning group (currently only `default` is allowed).
schema:
$ref: >-
#/components/schemas/PostHrisProvisioningGroupsGroupIdSetupLinksParameterGroupId
examples:
example1:
value: n39n320clr8c5amf8v83nbch
requestBody:
description: POST /hris/provisioning-groups/:group_id/setup-links Request body
content:
application/json:
schema:
$ref: >-
#/components/schemas/PostHrisProvisioningGroupsGroupIdSetupLinksRequestBody
examples:
example1:
value:
language: en
responses:
'200':
description: >-
POST /hris/provisioning-groups/:group_id/setup-links Positive
response
content:
application/json:
schema:
$ref: >-
#/components/schemas/PostHrisProvisioningGroupsGroupIdSetupLinksPositiveResponse
examples:
example1:
value:
status: success
data:
url: >-
https://connect.kombo.dev/v1/setup?token=GinuMJCpUQ9xdpLmD2ocw8qdiK3qiPCizDCv754EXri2vAX4
expires_at: '2023-10-11T12:00:00.000Z'
default:
$ref: '#/components/responses/ErrorResponseHRIS'
components:
schemas:
PostHrisProvisioningGroupsGroupIdSetupLinksParameterGroupId:
type: string
description: ID of the provisioning group (currently only `default` is allowed).
PostHrisProvisioningGroupsGroupIdSetupLinksRequestBody:
type: object
properties:
language:
type:
- string
- 'null'
enum:
- en
- de
- fr
- it
- es
default: en
description: >-
Language of the UI. Please note that the provisioning setup UI is
_not_ translated yet but we're working on it and setting this
already will make sure the translations appear once released.
PostHrisProvisioningGroupsGroupIdSetupLinksPositiveResponse:
type: object
properties:
status:
type: string
const: success
data:
type: object
properties:
url:
type: string
format: uri
description: The setup link URL to pass to the Kombo Connect SDK.
expires_at:
description: When this link expires.
type: string
format: date-time
externalDocs:
url: >-
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
required:
- url
- expires_at
examples:
- url: >-
https://connect.kombo.dev/v1/setup?token=GinuMJCpUQ9xdpLmD2ocw8qdiK3qiPCizDCv754EXri2vAX4
expires_at: '2023-10-11T12:00:00.000Z'
required:
- status
- data
responses:
ErrorResponseHRIS:
description: The standard error response with the error codes for the HRIS use case.
content:
application/json:
schema:
type: object
properties:
status:
type: string
enum:
- error
error:
type: object
properties:
code:
type:
- string
- 'null'
enum:
- PLATFORM.RATE_LIMIT_EXCEEDED
- PLATFORM.CONCURRENCY_LIMIT_EXCEEDED
- PLATFORM.INTEGRATION_NOT_FOUND
- PLATFORM.INPUT_INVALID
- PLATFORM.UNKNOWN_ERROR
- PLATFORM.IP_NOT_WHITELISTED
- PLATFORM.AUTHENTICATION_INVALID
- PLATFORM.TASK_TIMED_OUT
- INTEGRATION.PERMISSION_MISSING
- INTEGRATION.AUTHENTICATION_INVALID
- INTEGRATION.QA_FAILED
- INTEGRATION.SETUP_SYNC_PENDING
- INTEGRATION.SETUP_INCOMPLETE
- INTEGRATION.INACTIVE
- INTEGRATION.MODEL_NOT_AVAILABLE
- INTEGRATION.MODEL_DISABLED
- INTEGRATION.ACTION_NOT_AVAILABLE
- INTEGRATION.ACTION_DISABLED
- REMOTE.SERVICE_UNAVAILABLE
- REMOTE.RATE_LIMIT_EXCEEDED
- REMOTE.INPUT_INVALID
- REMOTE.UNKNOWN_HTTP_ERROR
- HRIS.STAFFING_ENTITY_CLOSED
- HRIS.EMPLOYEE_ALREADY_EXISTS
example: HRIS.EMPLOYEE_ALREADY_EXISTS
description: >-
Some errors include an error code that can be used to
identify their cause. See the [Error Handling
Docs](https://docs.kombo.dev/guides/errors) for more
information. For your error handling logic please use the
error `code` instead of other properties (e.g. message,
http status code, ...).
title:
type:
- string
- 'null'
description: A static, human-readable label.
message:
type: string
description: >-
A dynamic, detailed description of what went wrong in this
specific instance.
log_url:
type:
- string
- 'null'
format: uri
description: >-
The log page in the Kombo UI lists every interaction with
full details. If you need assistance, share that link with
our support team.
required:
- code
- title
- message
- log_url
description: Error details with structured code for programmatic handling.
required:
- status
- error
examples:
Error Response:
description: >-
When building error handling logic, always use the `code` field
to identify specific error types programmatically. See the
complete list of error codes in the
[docs](https://docs.kombo.dev/guides/errors).
value:
status: error
error:
code: INTEGRATION.MODEL_NOT_AVAILABLE
title: >-
This data model isn't supported for the selected
integration.
message: >-
The "employees" model is not yet available for Greenhouse.
Please reach out to Kombo if you need this functionality.
log_url: https://app.kombo.dev/my-prod/logs?interactionId=123456
Minimal Error Response:
description: >-
The "message" is always required while other fields can also be
`null`. See the [docs](https://docs.kombo.dev/guides/errors) for
more information.
value:
status: error
error:
code: null
title: null
message: The message is always in the response.
log_url: null
securitySchemes:
ApiKey:
type: http
scheme: bearer
description: >-
Create an API key on the [Secrets](https://app.kombo.dev/secrets) page
in the Kombo dashboard.
````