API Reference
Back to Developer PortalIntegrate with the Kumo HR platform. All API endpoints require authentication via an API key sent as a Bearer token.
Authentication
Getting your API key
Organization API keys are managed in Company Settings > Security > API Keys. Only Owners, Admins, and HR Managers can create company-level keys.
Headers
Authorization: Bearer YOUR_API_KEY — Required on all requests
x-tenant-id: TENANT_UUID — Required for multi-tenant contexts
Content-Type: application/json — For POST/PUT/PATCH requests
Quick start
# List employees curl -H "Authorization: Bearer kumo_your_key_here" \ -H "x-tenant-id: YOUR_TENANT_ID" \ https://app.kumohr.com/api/people
Base URL
https://app.kumohr.comError responses
Errors return 401 (unauthorized), 403 (forbidden), or 400 (bad request) with a JSON body containing error and reason fields.
People
Manage employees, profiles, avatars, and compensation data.
Leave
Leave balances, requests, policies, and calendar views.
Payroll
Payroll runs, approval batches, employee payroll data, and AI insights.
Performance
Reviews, goals, milestones, peer feedback, and performance insights.
Learning
Courses, learning paths, enrollments, skills, certificates, and AI content generation.
Time Tracking
Clock in/out, time entries, timesheets, and summaries.
Expenses
Submit and manage expenses, categories, and approval chains.
Compensation
Manage compensation adjustments, company-wide data, and exports.
Organization
Organization structure, departments, org charts, and hierarchy.
Onboarding
Onboarding journeys, templates, buddy assignments, and AI suggestions.
Offboarding
Manage employee offboarding workflows.
ATS (Recruiting)
Job postings, candidate pipeline, resume processing, and AI insights.
E-Signatures
Create, send, and manage electronic signature packages and templates.
Messages
Direct messaging, conversations, reactions, and file sharing.
Inventory
Company assets, assignments, and audit logs.
Certificates
Employee certificate requests and approvals.
Approval Flows
Configure and manage multi-step approval workflows.
Analytics
Generate reports, export data, and access analytics dashboards.
Search
Global search, semantic search, and search suggestions.
Notifications
Real-time notification streaming.
Work From Anywhere
Remote work requests, approvals, and checklists.
Playbook
Company playbook with sections, resources, and file uploads.
Company API Keys
Manage organization-wide API keys (requires Owner, Admin, or HR Manager role).
User
Current user profile, personal information, and preferences.