---
canonical_url: "https://docs.composio.dev/toolkits/hr_partner"
markdown_url: "https://docs.composio.dev/toolkits/hr_partner.md"
product: "platform"
version: null
last_updated: null
---

# HR Partner

HR Partner is a human resources platform for managing employee records, leave, recruitment, performance, timesheets, expenses, and related company data.

- **Category:** human resources
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `HR_PARTNER`
- **Version:** 00000000_00

## Tools

### Get Company

**Slug:** `HR_PARTNER_GET_COMPANY`

Return the connected HR Partner company's identity, subscription status, workforce counts, timezone, and optionally its custom fields and enabled modules.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include_custom_fields` | boolean | No | Include the company's custom employee-field definitions. |
| `include_active_modules` | boolean | No | Include feature flags showing which HR Partner modules are enabled. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee

**Slug:** `HR_PARTNER_GET_EMPLOYEE`

Return one employee's detailed HR profile, organization placement, manager, tags, contacts, addresses, and custom data by employee code.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `employee_code` | string | Yes | Exact HR Partner employee code, obtainable by listing employees or from another record's employee summary. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Recruitment Record

**Slug:** `HR_PARTNER_GET_RECRUITMENT_RECORD`

Return one detailed job, applicant, or application using an identifier from recruitment search results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `identifier` | string | Yes | Job slug, applicant ID or email, or numeric application ID, according to record_type. |
| `record_type` | string ("job" | "applicant" | "application") | Yes | Type of recruitment record to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employee Records

**Slug:** `HR_PARTNER_LIST_EMPLOYEE_RECORDS`

List employee contacts, addresses, goals, checklists, absences, assets, attachments, benefits, dependents, education, grievances, interviews, notes, positions, renewables, legacy reviews, skills, or training records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `search` | string | No | Text filter whose target depends on record_type: contact details for contacts; location for addresses; template name for checklists; comments for absences; person name for dependents; qualification for education; note text for notes; position title for positions; skill name for skills; course name for training; and description for other supported types. |
| `status` | string | No | Exact company-configured status name. Supported for absences, benefits, education, grievances, legacy_reviews, and training. For checklists, use checklist_status instead. |
| `date_to` | string | No | Latest date in YYYY-MM-DD, using the same record-type-specific date field described for date_from. |
| `date_from` | string | No | Earliest date in YYYY-MM-DD. Maps to due date for goals; assigned date for checklists; absence date for absences; checkout date for assets; upload date for attachments; start date for benefits; birth date for dependents; commence date for education, positions, and training; reported date for grievances; interview date for interviews; created date for notes; renewal date for renewables; and review date for legacy_reviews. |
| `department` | string | No | Department name, or comma-separated department names where supported. |
| `record_type` | string ("contacts" | "addresses" | "goals" | "checklists" | "absences" | "assets" | "attachments" | "benefits" | "dependents" | "education" | "grievances" | "interviews" | "notes" | "positions" | "renewables" | "legacy_reviews" | "skills" | "training") | Yes | Kind of employee HR record to return. legacy_reviews selects the older review records, not performance-management cycles. |
| `employee_code` | string | No | Employee code to match. Not supported for contacts or addresses, whose collection APIs only expose text search. |
| `include_details` | boolean | No | For checklists only, include checklist item details and files. |
| `checklist_status` | string ("new" | "incomplete" | "complete" | "archived") | No | Checklist workflow status. Valid only when record_type is checklists. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employees

**Slug:** `HR_PARTNER_LIST_EMPLOYEES`

Find employee summaries using name, organization, status, tag, manager, and employment-date filters. Returns the complete matching set because HR Partner does not paginate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | No | Employee tag to match. |
| `group` | string | No | Employee group name to match. |
| `search` | string | No | Search employee names and other provider-indexed identity fields. |
| `location` | string | No | Location name to match. |
| `position` | string | No | Position title to match. |
| `is_active` | boolean | No | Filter by active status when provided. |
| `department` | string | No | Department name; use a comma-separated list to match multiple departments. |
| `reports_to` | string | No | Employee code of the manager whose direct reports should be returned. |
| `is_terminated` | boolean | No | Filter by termination status when provided. |
| `start_date_to` | string | No | Latest employment start date, formatted YYYY-MM-DD. |
| `start_date_from` | string | No | Earliest employment start date, formatted YYYY-MM-DD. |
| `employment_status` | string | No | Exact configured employment status name to match. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Expenses

**Slug:** `HR_PARTNER_LIST_EXPENSES`

Return expense claims as a detailed, summary, or transaction report with employee, organization, date, status, payment, category, and project filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("submitted" | "approved" | "pending" | "rejected") | No | Expense workflow status to match. |
| `is_paid` | boolean | No | Filter by payment state when provided. |
| `project` | string | No | Project name to match. |
| `location` | string | No | Location name, or comma-separated location names. |
| `department` | string | No | Department name, or comma-separated department names. |
| `report_type` | string ("detailed" | "summary" | "transaction") | Yes | Report shape: detailed includes claims, lines, and attachments; summary omits lines; transaction flattens detail lines. |
| `employee_code` | string | No | Employee code to match. |
| `expense_date_to` | string | No | Latest expense date, formatted YYYY-MM-DD. |
| `expense_category` | string | No | Expense category name to match. |
| `expense_date_from` | string | No | Earliest expense date, formatted YYYY-MM-DD. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Leave Data

**Slug:** `HR_PARTNER_LIST_LEAVE_DATA`

List either leave requests or employee leave balances using only filters supported by the selected data type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("submitted" | "pending" | "approved" | "rejected" | "revoked" | "withdrawn") | No | Leave request workflow status. Valid only for requests. |
| `date_to` | string | No | Latest leave start date, formatted YYYY-MM-DD. Valid only for requests. |
| `location` | string | No | Location name, or comma-separated location names. |
| `data_type` | string ("requests" | "balances") | Yes | Whether to return leave request records or current leave balances. |
| `date_from` | string | No | Earliest leave start date, formatted YYYY-MM-DD. Valid only for requests. |
| `is_active` | boolean | No | Employee active-state filter. Valid only for balances. |
| `department` | string | No | Department name, or comma-separated department names. |
| `request_type` | string ("taken" | "added") | No | Leave taken versus TOIL or Flexi added. Valid only for requests. |
| `employee_code` | string | No | Employee code to match. |
| `absence_reason` | string | No | Leave or absence reason name to match. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Performance Reviews

**Slug:** `HR_PARTNER_LIST_PERFORMANCE_REVIEWS`

List performance-management review cycles by employee, organization, status, and review dates, optionally including selected reviewer forms and answers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `location` | string | No | Location name, or comma-separated names. |
| `position` | string | No | Position name, or comma-separated names. |
| `form_data` | array | No | Reviewer form types to include. The selected values are sent to HR Partner as one comma-separated form_data filter. |
| `department` | string | No | Department name, or comma-separated names. |
| `employee_code` | string | No | Employee code to match. |
| `review_status` | string ("planned" | "pending" | "complete" | "cancelled") | No | Performance review cycle status. |
| `review_date_to` | string | No | Latest review date in YYYY-MM-DD. |
| `include_answers` | boolean | No | Include answers for the selected form_data types. |
| `review_date_from` | string | No | Earliest review date in YYYY-MM-DD. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Timesheets

**Slug:** `HR_PARTNER_LIST_TIMESHEETS`

List timesheet sequences and entries by employee, organization, sequence dates, status, project, activity, and approval, export, or lock state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("new" | "submitted" | "accepted" | "rejected" | "processed") | No | Timesheet workflow status. |
| `date_to` | string | No | Latest timesheet entry date in YYYY-MM-DD; date_from is also required. |
| `project` | string | No | Project name to match. |
| `activity` | string | No | Project activity name to match. |
| `location` | string | No | Location name to match. |
| `date_from` | string | No | Earliest timesheet entry date in YYYY-MM-DD; date_to is also required. |
| `is_locked` | boolean | No | Filter by lock state. |
| `department` | string | No | Department name to match. |
| `is_approved` | boolean | No | Filter by approval state. |
| `is_exported` | boolean | No | Filter by export state. |
| `employee_code` | string | No | Employee code to match. |
| `timesheet_name` | string | No | Timesheet template or sequence name to match. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Recruitment

**Slug:** `HR_PARTNER_SEARCH_RECRUITMENT`

List jobs, applicants, applications for one job, or application stage changes using resource-appropriate recruitment filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `stage` | string | No | Current stage filter for applications only. |
| `job_id` | string | No | Job slug. Required for applications and optional for stage changes. |
| `search` | string | No | Text search for jobs or applicants; invalid for applications and stage changes. |
| `date_to` | string | No | Latest publish, submission, or stage-change date, formatted YYYY-MM-DD. |
| `location` | string | No | Location filter for jobs only. |
| `resource` | string ("jobs" | "applicants" | "applications" | "stage_changes") | Yes | Recruitment collection to search. |
| `to_stage` | string | No | New stage filter for stage changes only. |
| `applicant` | string | No | Applicant ID or email filter for stage changes only. |
| `date_from` | string | No | Earliest publish, submission, or stage-change date, formatted YYYY-MM-DD. |
| `is_active` | boolean | No | Active-state filter for jobs only. |
| `department` | string | No | Department filter for jobs only. |
| `from_stage` | string | No | Prior stage filter for stage changes only. |
| `is_flagged` | boolean | No | Flagged-state filter for applications only. |
| `is_archived` | boolean | No | Archived-state filter for applications only. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |