> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# HR Partner

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

![HR Partner logo](https://mintcdn.com/composio-preview/o1IUBrrsmtgkhmyf/images/toolkits/hr_partner.svg?fit=max\&auto=format\&n=o1IUBrrsmtgkhmyf\&q=85\&s=09c8652b83e2845a8f241e836e1d09f9)

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

## Tools

> [accordion] 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
>
> **include\_custom\_fields** `boolean`
>
> Include the company's custom employee-field definitions.
>
> **include\_active\_modules** `boolean`
>
> Include feature flags showing which HR Partner modules are enabled.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **employee\_code** `string` *required*
>
> Exact HR Partner employee code, obtainable by listing employees or from another record's employee summary.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **identifier** `string` *required*
>
> Job slug, applicant ID or email, or numeric application ID, according to record\_type.
>
> **record\_type** `string ("job" | "applicant" | "application")` *required*
>
> Type of recruitment record to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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. A specific contacts resource-not-found response is returned as an empty list.
>
> #### Input Parameters
>
> **search** `string`
>
> 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`
>
> Exact company-configured status name. Supported for absences, benefits, education, grievances, legacy\_reviews, and training. For checklists, use checklist\_status instead.
>
> **date\_to** `string`
>
> Latest date in YYYY-MM-DD, using the same record-type-specific date field described for date\_from.
>
> **date\_from** `string`
>
> 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`
>
> 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")` *required*
>
> Kind of employee HR record to return. legacy\_reviews selects the older review records, not performance-management cycles.
>
> **employee\_code** `string`
>
> Employee code to match. Not supported for contacts or addresses, whose collection APIs only expose text search.
>
> **include\_details** `boolean`
>
> For checklists only, include checklist item details and files.
>
> **checklist\_status** `string ("new" | "incomplete" | "complete" | "archived")`
>
> Checklist workflow status. Valid only when record\_type is checklists.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Employees
>
> **Slug:** `HR_PARTNER_LIST_EMPLOYEES`
>
> Find employee summaries using name, organization, status, tag, manager, and employment-start-date filters. A specific resource-not-found response is returned as an empty list.
>
> #### Input Parameters
>
> **tag** `string`
>
> Employee tag to match.
>
> **group** `string`
>
> Employee group name to match.
>
> **search** `string`
>
> Search employee names and other provider-indexed identity fields.
>
> **location** `string`
>
> Location name to match.
>
> **position** `string`
>
> Position title to match.
>
> **is\_active** `boolean`
>
> Filter by active status when provided.
>
> **department** `string`
>
> Department name; use a comma-separated list to match multiple departments.
>
> **reports\_to** `string`
>
> Employee code of the manager whose direct reports should be returned.
>
> **is\_terminated** `boolean`
>
> Filter by termination status when provided.
>
> **start\_date\_to** `string`
>
> Latest employment start date, formatted YYYY-MM-DD.
>
> **start\_date\_from** `string`
>
> Earliest employment start date, formatted YYYY-MM-DD.
>
> **employment\_status** `string`
>
> Exact configured employment status name to match.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **status** `string ("submitted" | "approved" | "pending" | "rejected")`
>
> Expense workflow status to match.
>
> **is\_paid** `boolean`
>
> Filter by payment state when provided.
>
> **project** `string`
>
> Project name to match.
>
> **location** `string`
>
> Location name, or comma-separated location names.
>
> **department** `string`
>
> Department name, or comma-separated department names.
>
> **report\_type** `string ("detailed" | "summary" | "transaction")` *required*
>
> Report shape: detailed includes claims, lines, and attachments; summary omits lines; transaction flattens detail lines.
>
> **employee\_code** `string`
>
> Employee code to match.
>
> **expense\_date\_to** `string`
>
> Latest expense date, formatted YYYY-MM-DD.
>
> **expense\_category** `string`
>
> Expense category name to match.
>
> **expense\_date\_from** `string`
>
> Earliest expense date, formatted YYYY-MM-DD.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **status** `string ("submitted" | "pending" | "approved" | "rejected" | "revoked" | "withdrawn")`
>
> Leave request workflow status. Valid only for requests.
>
> **date\_to** `string`
>
> Latest leave start date, formatted YYYY-MM-DD. Valid only for requests.
>
> **location** `string`
>
> Location name, or comma-separated location names.
>
> **data\_type** `string ("requests" | "balances")` *required*
>
> Whether to return leave request records or current leave balances.
>
> **date\_from** `string`
>
> Earliest leave start date, formatted YYYY-MM-DD. Valid only for requests.
>
> **is\_active** `boolean`
>
> Employee active-state filter. Valid only for balances.
>
> **department** `string`
>
> Department name, or comma-separated department names.
>
> **request\_type** `string ("taken" | "added")`
>
> Leave taken versus TOIL or Flexi added. Valid only for requests.
>
> **employee\_code** `string`
>
> Employee code to match.
>
> **absence\_reason** `string`
>
> Leave or absence reason name to match.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **location** `string`
>
> Location name, or comma-separated names.
>
> **position** `string`
>
> Position name, or comma-separated names.
>
> **form\_data** `array`
>
> Reviewer form types to include. The selected values are sent to HR Partner as one comma-separated form\_data filter.
>
> **department** `string`
>
> Department name, or comma-separated names.
>
> **employee\_code** `string`
>
> Employee code to match.
>
> **review\_status** `string ("planned" | "pending" | "complete" | "cancelled")`
>
> Performance review cycle status.
>
> **review\_date\_to** `string`
>
> Latest review date in YYYY-MM-DD.
>
> **include\_answers** `boolean`
>
> Include answers for the selected form\_data types.
>
> **review\_date\_from** `string`
>
> Earliest review date in YYYY-MM-DD.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Timesheets
>
> **Slug:** `HR_PARTNER_LIST_TIMESHEETS`
>
> List timesheet sequences and entries by employee, organization, entry dates, status, project, activity, and approval, export, or lock state. Entry date bounds must be supplied together.
>
> #### Input Parameters
>
> **status** `string ("new" | "submitted" | "accepted" | "rejected" | "processed")`
>
> Timesheet workflow status.
>
> **date\_to** `string`
>
> Latest timesheet entry date in YYYY-MM-DD; date\_from is also required.
>
> **project** `string`
>
> Project name to match.
>
> **activity** `string`
>
> Project activity name to match.
>
> **location** `string`
>
> Location name to match.
>
> **date\_from** `string`
>
> Earliest timesheet entry date in YYYY-MM-DD; date\_to is also required.
>
> **is\_locked** `boolean`
>
> Filter by lock state.
>
> **department** `string`
>
> Department name to match.
>
> **is\_approved** `boolean`
>
> Filter by approval state.
>
> **is\_exported** `boolean`
>
> Filter by export state.
>
> **employee\_code** `string`
>
> Employee code to match.
>
> **timesheet\_name** `string`
>
> Timesheet template or sequence name to match.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Recruitment
>
> **Slug:** `HR_PARTNER_SEARCH_RECRUITMENT`
>
> List jobs, applicants, applications for one job, or application stage changes using resource-appropriate recruitment filters. Stage-change responses are limited to 500 records.
>
> #### Input Parameters
>
> **stage** `string`
>
> Current stage filter for applications only.
>
> **job\_id** `string`
>
> Job slug. Required for applications and optional for stage changes.
>
> **search** `string`
>
> Text search for jobs or applicants; invalid for applications and stage changes.
>
> **date\_to** `string`
>
> Latest publish, submission, or stage-change date, formatted YYYY-MM-DD.
>
> **location** `string`
>
> Location filter for jobs only.
>
> **resource** `string ("jobs" | "applicants" | "applications" | "stage_changes")` *required*
>
> Recruitment collection to search.
>
> **to\_stage** `string`
>
> New stage filter for stage changes only.
>
> **applicant** `string`
>
> Applicant ID or email filter for stage changes only.
>
> **date\_from** `string`
>
> Earliest publish, submission, or stage-change date, formatted YYYY-MM-DD.
>
> **is\_active** `boolean`
>
> Active-state filter for jobs only.
>
> **department** `string`
>
> Department filter for jobs only.
>
> **from\_stage** `string`
>
> Prior stage filter for stage changes only.
>
> **is\_flagged** `boolean`
>
> Flagged-state filter for applications only.
>
> **is\_archived** `boolean`
>
> Archived-state filter for applications only.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
