Guides
Signup For Free

Kallidus API Integration

Suggest Edits

These are the list of integration use cases supported by Knit for Kallidus API as part of the HRIS category

Delete a Task

  • ID: delete_a_task
  • Operation: write
  • Entities: task
  • Summary: The 'Delete a Task' API endpoint allows users to delete a specific task identified by its ID (9417) using the DELETE method. The request requires an optional 'Authorization' header containing a Bearer token for authentication. The endpoint does not require any request body or additional parameters. Upon successful deletion, the API returns a response with no specific body content, and the response example indicates an error message stating 'No Response Example - Dropdown not found'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Webhook

  • ID: delete_a_webhook
  • Operation: write
  • Entities: webhook
  • Summary: The Delete a Webhook API allows users to delete a specific webhook by its ID. The API requires the 'webhookId' as a path parameter, which is mandatory. An optional 'Authorization' header can be provided for authentication purposes. The API responds with a status code of 200 and a message indicating success. The response headers include various metadata such as caching policies, security policies, and server information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Users in Sapling Account

  • ID: get_all_users_in_sapling_account
  • Operation: read
  • Entities: user, profile, account
  • Summary: This API endpoint retrieves all users in the Sapling account. It returns a list of users with their details such as GUID, start date, name, job title, location, department, and more. The response includes pagination information like current page, total pages, and total users. The Authorization header is required and should contain a Bearer token for authorization. The response headers provide metadata about the response, including server information and caching details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get API-Transferable Profile Fields

  • ID: get_api_transferable_profile_fields
  • Operation: read
  • Entities: profile, field, section
  • Summary: This API endpoint retrieves a list of API-transferable profile fields available at your company. It uses the GET method and requires an optional Authorization header with a Bearer token for access. The response includes various profile fields, each with attributes such as id, name, section, and type. Some fields may also include options or sub-fields. The response headers provide additional metadata about the request, such as caching and content encoding details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Individual Profile Field for All Users

  • ID: get_individual_profile_field_for_all_users
  • Operation: read
  • Entities: profile, field, user
  • Summary: This API endpoint retrieves an individual profile field for all users at a company. The profile fields can be alphanumeric for permanent fields or Field IDs for custom fields. The API requires an optional 'Authorization' header with a Bearer token and an optional 'Content-Type' header. The response includes details such as the current page, total pages, total users, and a list of users with their unique GUID, field ID, and spirit animal. The response headers provide additional metadata about the request and response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get List of All Tasks

  • ID: get_list_of_all_tasks
  • Operation: read
  • Entities: owner, task, workflow
  • Summary: This API endpoint retrieves a list of all tasks. It requires a GET request to the specified URL with optional headers for authorization and content type. The response includes detailed information about the tasks, such as workflow ID, task ID, name, description, and other metadata. The response headers provide additional information about the server and security policies.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Pending Hire Details

  • ID: get_pending_hire_details
  • Operation: read
  • Entities: department, customer, pending hire
  • Summary: The Get Pending Hire Details API retrieves information about a single pending hire in Sapling. It requires the 'pendingHireId' as a path parameter to identify the specific pending hire. The request can include an optional 'Authorization' header with a Bearer token for authentication. The response includes details about the pending hire, such as their name, start date, status, and other personal and employment information. The response is returned in plain text format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Pending Hires in Sapling

  • ID: get_pending_hires_in_sapling
  • Operation: read
  • Entities: user, customer, pending hire
  • Summary: This API endpoint retrieves all pending hires in Sapling. It requires an optional Authorization header with a Bearer token for authentication and an optional 'accept' header to specify the response format, which defaults to 'text/plain'. The response includes details such as the current page, total pages, total pending hires, customer information, and a list of pending hires with their respective details like pendingHireID, startDate, firstName, lastName, status, and more.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get User Profile Information from Sapling Platform

  • ID: get_user_profile_information_from_sapling_platform
  • Operation: read
  • Entities: profile, user, compensation
  • Summary: This API endpoint retrieves detailed information about a user from the Sapling platform using their unique GUID. The request requires the GUID as a path parameter and optionally an Authorization header with a Bearer token. The response includes comprehensive user details such as personal information, job title, location, department, compensation details, and more. The response headers provide metadata about the request processing, and the response body contains the user's profile information in a structured JSON format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Webhook Details

  • ID: get_webhook_details
  • Operation: read
  • Entities: department, webhook, location
  • Summary: The Get Webhook Details API retrieves detailed information about a specific webhook identified by the webhookId path parameter. The request requires an optional Authorization header with a Bearer token and an optional accept header specifying the content type. The response includes various headers such as Transfer-Encoding, Connection, Date, and others, along with a JSON body containing details about the webhook, including its ID, event, URL, description, status, creation and update timestamps, and other related information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Webhooks

  • ID: get_webhooks
  • Operation: read
  • Entities: department, webhook, location
  • Summary: The Get Webhooks API endpoint retrieves a list of webhooks from the server. It requires the 'page' and 'status' query parameters to filter the results. The 'Authorization' header is optional and should contain a Bearer token for authentication. The response includes pagination details such as 'current_page', 'total_pages', and 'total_webhooks', along with an array of webhook objects. Each webhook object contains details like 'webhookId', 'event', 'url', 'description', 'status', 'createdAt', 'createdBy', 'updatedAt', 'updatedBy', 'triggeredBy', 'lastTriggered', 'lastTriggeredEventStatus', 'configurable', and 'appliesTo'. The response headers provide additional metadata about the request and response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Pending Hire in Sapling

  • ID: post_create_a_new_pending_hire_in_sapling
  • Operation: write
  • Entities: user, department, pending hire
  • Summary: This API endpoint allows the creation of a new pending hire in Sapling. Once a pending hire is created, a Sapling user can initiate onboarding for this pending hire, converting them to a User. The API requires a POST request to the specified URL with headers for authorization and content type. The request body must include required fields such as personalEmail, firstName, lastName, startDate, and source, among others. The response returns details of the created pending hire, including customer information, a message indicating success, status code, and unique identifiers for the user.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New User in Sapling

  • ID: post_create_a_new_user_in_sapling
  • Operation: write
  • Entities: user, department, pending hire
  • Summary: This API endpoint allows the creation of a new user in Sapling. Once a user is created, a Sapling user can manage the user details. The API requires a POST request to the specified URL with headers for authorization and content type. The request body must include required fields such as company_email, first_name, last_name, start_date, and job_title, among others. The response returns a status code of 200 indicating the successful creation of the user.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Webhook

  • ID: post_create_a_webhook
  • Operation: write
  • Entities: department, webhook, event
  • Summary: The Create a Webhook API allows users to create a new webhook in the system. The API is accessed via a POST request to the specified endpoint. The request requires an optional Authorization header with a Bearer token and an accept header specifying the content type as application/json. The response returns a status code of 201 indicating successful creation, along with detailed information about the created webhook, including its ID, event, URL, description, status, creation and update timestamps, and applicable configurations.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create User Profile in Sapling Account

  • ID: post_create_user_profile_in_sapling_account
  • Operation: write
  • Entities: user, profile, account
  • Summary: This API endpoint allows you to create a new user profile in your Sapling account. The request requires several fields including company email, first name, preferred name, last name, start date, job title, department, location, and status. The request must include an Authorization header with a Bearer token and a Content-Type header set to application/x-www-form-urlencoded. The response does not provide a specific example but indicates an error message if applicable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Webhook

  • ID: put_update_a_webhook
  • Operation: write
  • Entities: department, webhook, location
  • Summary: The Update a Webhook API allows you to update the details of an existing webhook identified by the webhookId path parameter. The request requires an optional Authorization header with a Bearer token and an accept header specifying the content type. The response includes various headers such as Transfer-Encoding, Connection, Date, and others, along with a JSON body containing the status, message, and updated webhook details including webhookId, event, url, description, status, createdAt, createdBy, updatedAt, updatedBy, triggeredBy, lastTriggered, lastTriggeredEventStatus, configurable, and appliesTo fields.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update or Modify a Task

  • ID: put_update_or_modify_a_task
  • Operation: write
  • Entities: task
  • Summary: This API endpoint is used to update or modify a task identified by the ID 9417. It uses the PUT method and requires an optional 'Authorization' header with a Bearer token for authorization. The request does not require a request body. The response is expected to return a status code of 200, but no specific response body example is provided, only an error message indicating that no response example is available.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Pending Hire in Sapling

  • ID: put_update_pending_hire_in_sapling
  • Operation: write
  • Entities: user, customer, pending hire
  • Summary: This API endpoint allows you to update an existing pending hire in Sapling. It requires the 'pendingHireId' as a path parameter to identify the pending hire to be updated. The request must include an Authorization header with a Bearer token. The request body should contain the necessary data to update the pending hire. The response includes details about the customer, a message indicating the update status, a status code, and unique identifiers for the update and user.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update User Profile in Sapling Account

  • ID: put_update_user_profile_in_sapling_account
  • Operation: write
  • Entities: field, user, guid
  • Summary: This API updates a user in your Sapling account using the PUT method. The user is identified by a GUID, which is a required path parameter. The GUIDs for users can be obtained from the Users resource, and the Field IDs for updating specific fields can be obtained from the Fields resource. The request requires a 'Authorization' header with a Bearer token and a 'Content-Type' header set to 'application/x-www-form-urlencoded'. The body of the request can include various fields such as start_date, first_name, last_name, job_title, location, department, and more. The response does not have a detailed example.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated about 1 month ago