Skip to main content
HR Partner logo
  • Category: human resources
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: HR_PARTNER
  • Version: 20261101_00

Tools

Slug: HR_PARTNER_GET_COMPANYReturn the connected HR Partner company’s identity, subscription status, workforce counts, timezone, and optionally its custom fields and enabled modules.

Input Parameters

boolean
Include the company’s custom employee-field definitions.
boolean
Include feature flags showing which HR Partner modules are enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HR_PARTNER_GET_EMPLOYEEReturn one employee’s detailed HR profile, organization placement, manager, tags, contacts, addresses, and custom data by employee code.

Input Parameters

string
required
Exact HR Partner employee code, obtainable by listing employees or from another record’s employee summary.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HR_PARTNER_GET_RECRUITMENT_RECORDReturn one detailed job, applicant, or application using an identifier from recruitment search results.

Input Parameters

string
required
Job slug, applicant ID or email, or numeric application ID, according to record_type.
string ("job" | "applicant" | "application")
required
Type of recruitment record to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HR_PARTNER_LIST_EMPLOYEE_RECORDSList 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

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.
string
Exact company-configured status name. Supported for absences, benefits, education, grievances, legacy_reviews, and training. For checklists, use checklist_status instead.
string
Latest date in YYYY-MM-DD, using the same record-type-specific date field described for 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.
string
Department name, or comma-separated department names where supported.
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.
string
Employee code to match. Not supported for contacts or addresses, whose collection APIs only expose text search.
boolean
For checklists only, include checklist item details and files.
string ("new" | "incomplete" | "complete" | "archived")
Checklist workflow status. Valid only when record_type is checklists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HR_PARTNER_LIST_EMPLOYEESFind 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

string
Employee tag to match.
string
Employee group name to match.
string
Search employee names and other provider-indexed identity fields.
string
Location name to match.
string
Position title to match.
boolean
Filter by active status when provided.
string
Department name; use a comma-separated list to match multiple departments.
string
Employee code of the manager whose direct reports should be returned.
boolean
Filter by termination status when provided.
string
Latest employment start date, formatted YYYY-MM-DD.
string
Earliest employment start date, formatted YYYY-MM-DD.
string
Exact configured employment status name to match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HR_PARTNER_LIST_EXPENSESReturn expense claims as a detailed, summary, or transaction report with employee, organization, date, status, payment, category, and project filters.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HR_PARTNER_LIST_LEAVE_DATAList either leave requests or employee leave balances using only filters supported by the selected data type.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HR_PARTNER_LIST_PERFORMANCE_REVIEWSList performance-management review cycles by employee, organization, status, and review dates, optionally including selected reviewer forms and answers.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HR_PARTNER_LIST_TIMESHEETSList 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

string ("new" | "submitted" | "accepted" | "rejected" | "processed")
Timesheet workflow status.
string
Latest timesheet entry date in YYYY-MM-DD; date_from is also required.
string
Project name to match.
string
Project activity name to match.
string
Location name to match.
string
Earliest timesheet entry date in YYYY-MM-DD; date_to is also required.
boolean
Filter by lock state.
string
Department name to match.
boolean
Filter by approval state.
boolean
Filter by export state.
string
Employee code to match.
string
Timesheet template or sequence name to match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HR_PARTNER_SEARCH_RECRUITMENTList 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

string
Current stage filter for applications only.
string
Job slug. Required for applications and optional for stage changes.
string
Text search for jobs or applicants; invalid for applications and stage changes.
string
Latest publish, submission, or stage-change date, formatted YYYY-MM-DD.
string
Location filter for jobs only.
string ("jobs" | "applicants" | "applications" | "stage_changes")
required
Recruitment collection to search.
string
New stage filter for stage changes only.
string
Applicant ID or email filter for stage changes only.
string
Earliest publish, submission, or stage-change date, formatted YYYY-MM-DD.
boolean
Active-state filter for jobs only.
string
Department filter for jobs only.
string
Prior stage filter for stage changes only.
boolean
Flagged-state filter for applications only.
boolean
Archived-state filter for applications only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not