Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
What can you do with it?

The /kallidus-sapling command enables you to manage human resources through the Kallidus Sapling HRM platform API. Perfect for employee lifecycle management, user administration, task management, and streamlining HR workflows in your organization.

​
How to use it?

​
Basic Command Structure

/your-kallidus-sapling-connection [action] [required-parameters] [optional-parameters]

​
Parameters

Required:
  • id - Resource ID for specific operations
Optional:
  • first_name - Employee first name
  • last_name - Employee last name
  • email - Employee email address
  • job_title - Employee job title
  • status - Employee status

​
Tools

​
Retrieve User List

Retrieve a list of all users within the account Parameters:
  • None required
Example: 
/your-kallidus-sapling-connection
action: list_users
Response: 
[
  {
    "id": 20,
    "first_name": "John",
    "last_name": "Doe",
    "preferred_name": "John",
    "job_title": "Software Engineer",
    "status": "active",
    "email": "john.doe@example.com",
    "personal_email": "johndoe@personal.com",
    "start_date": "2024-01-15"
  },
  {
    "id": 21,
    "first_name": "Jane",
    "last_name": "Smith",
    "preferred_name": "Jane",
    "job_title": "Product Manager",
    "status": "active",
    "email": "jane.smith@example.com",
    "personal_email": "janesmith@personal.com",
    "start_date": "2023-11-20"
  }
]

​
Update Task

Update a specific task by its ID Parameters:
  • id (required) - Task ID to update
  • title (optional) - Task title
  • description (optional) - Task description
  • due_date (optional) - Task due date
  • status (optional) - Task status
Example: 
/your-kallidus-sapling-connection
action: update_task
id: 453
title: "Complete Compliance Training"
description: "Annual compliance and security training."
due_date: "2025-09-30"
status: "in_progress"
Response: 
{
  "id": 453,
  "title": "Complete Compliance Training",
  "description": "Annual compliance and security training.",
  "due_date": "2025-09-30",
  "status": "in_progress",
  "assignee_id": 20,
  "updated_at": "2025-08-11T13:00:00Z"
}

​
Notes

Kallidus Sapling is a Human Resource Management (HRM) platform that helps organizations automate and streamline employee lifecycle processes. Its API allows for managing employee data, workflows, and tasks, enabling seamless integration with other systems.