SmartHR
SmartHR is a cloud human resources platform for managing employee records, organization data, payroll documents, and HR workflows.
116 actionsAPI key
What your bot can do in SmartHR
Looks up
- Get Batch JobGet one SmartHR background batch job by ID, optionally embedding its attachments.
- Get DepartmentGet one SmartHR department by its department ID.
- Get EmployeeGet one employee by SmartHR employee ID, with optional comma-separated field selection.
- Get Employee Custom Field TemplateGet one employee custom-field template by ID.
- Get Employee Custom Field Template GroupGet one employee custom-field template group by ID.
- Get Employee DependentGet one dependent belonging to an employee.
- Get Employee Input FormGet one SmartHR employee information-collection form by ID, preserving its nested field groups, fields, and embedded custom-field…
- Get Employment TypeGet one SmartHR employment type by its employment type ID.
- Get GradeGet one SmartHR grade by its grade ID.
- Get Job CategoryGet one SmartHR job category by its job category ID.
Show 37 more
- Get Job TitleGet one SmartHR job title by its job title ID.
- Get Mail FormatGet one SmartHR mail format by ID, optionally embedding the employee information-collection forms that use it.
- Get Payment PeriodGet one SmartHR payroll payment period by its payment period ID.
- Get PayrollGet one sensitive SmartHR payroll group by ID.
- Get PayslipGet one highly sensitive SmartHR payslip from a payroll group.
- Get Recruitment TypeGet one SmartHR recruitment type by its recruitment type ID.
- Get Tax WithholdingGet one highly sensitive SmartHR tax-withholding group by ID.
- Get Tax Withholding SlipGet one highly sensitive SmartHR tax-withholding slip from a tax-withholding group.
- Get UserGet one SmartHR user account by user ID with an optional related object embedded in the response.
- Get User SAML ConfigurationGet the SAML SSO account configuration for one SmartHR user.
- Get WebhookGet one SmartHR webhook configuration by webhook ID.
- List Bank Account SettingsList one page of SmartHR bank-account setting definitions.
- List Batch JobsList one page of SmartHR background batch jobs.
- List Business EstablishmentsList one page of SmartHR business establishments, optionally embedding the social insurance representative, labor insurance…
- List CompaniesList one page of SmartHR companies with an optional embedded owner.
- List DepartmentsList one page of SmartHR departments using the documented code and sort filters.
- List Dependent Custom Field TemplatesList one page of SmartHR custom-field templates for employee dependents.
- List Dependent RelationsList one page of configured SmartHR dependent relationship types.
- List Employee Custom Field Template GroupsList one page of employee custom-field template groups.
- List Employee Custom Field TemplatesList one page of SmartHR employee custom-field templates.
- List Employee DependentsList one page of sensitive family and dependent records for a SmartHR employee.
- List Employee Input FormsList one page of SmartHR employee information-collection forms with their nested field definitions.
- List Employee Maternity and Childcare LeavesList one page of sensitive maternity and childcare leave records for a SmartHR employee.
- List EmployeesList one page of employees matching SmartHR's documented employee filters.
- List Employment TypesList one page of SmartHR employment types.
- List GradesList one page of SmartHR grades.
- List Job CategoriesList one page of SmartHR job categories.
- List Job TitlesList one page of SmartHR job titles using the documented sort option.
- List Mail FormatsList one page of SmartHR mail formats.
- List Payment PeriodsList one page of SmartHR payroll payment periods.
- List PayrollsList one page of sensitive SmartHR payroll groups using payment-date and payment-type filters.
- List PayslipsList one page of highly sensitive SmartHR payslips in a payroll group.
- List Recruitment TypesList one page of SmartHR recruitment types.
- List Tax Withholding SlipsList one page of sensitive tax-withholding slips in a SmartHR tax-withholding group.
- List Tax WithholdingsList one page of sensitive SmartHR tax-withholding groups.
- List UsersList one page of SmartHR user accounts with the documented sort and embed options, invitation status, role, and email-delivery status.
- List WebhooksList one page of SmartHR webhook configurations.
Takes action
- Bulk Create PayslipsCreate up to 100 sensitive payslip entries in one SmartHR payroll group.
- Create DepartmentCreate a SmartHR department.
- Create EmployeeCreate an employee using the documented SmartHR employee fields.
- Create Employee Custom Field TemplateCreate an employee custom-field template.
- Create Employee Custom Field Template GroupCreate an employee custom-field template group.
- Create Employee DependentCreate a dependent for one employee using the documented family fields.
- Create Employment TypeCreate a SmartHR employment type.
- Create GradeCreate a SmartHR grade.
- Create Job CategoryCreate a SmartHR job category.
- Create Job TitleCreate a SmartHR job title.
Show 59 more
- Create PayrollCreate a sensitive SmartHR payroll group.
- Create PayslipCreate a sensitive employee payslip in one SmartHR payroll group.
- Create Recruitment TypeCreate a SmartHR recruitment type.
- Create Tax WithholdingCreate a sensitive SmartHR tax-withholding group in the unconfirmed state.
- Create Tax Withholding SlipCreate a file-backed or field-backed sensitive tax-withholding slip for an employee in one SmartHR tax-withholding group.
- Create User SAML ConfigurationCreate the SAML SSO account configuration for one SmartHR user.
- Create WebhookCreate a SmartHR webhook configuration for future employee and dependent events.
- Delete EmployeePermanently delete one employee by SmartHR employee ID.
- Delete Employee Custom Field TemplateDelete one employee custom-field template by ID.
- Delete Employee Custom Field Template GroupDelete one employee custom-field template group by ID.
- Delete Employee DependentPermanently delete one dependent and their sensitive family data from an employee record.
- Delete Employment TypeDelete one SmartHR employment type by ID.
- Delete GradeDelete one SmartHR grade by ID.
- Delete Job CategoryDelete one SmartHR job category by ID.
- Delete Job TitleDelete one SmartHR job title by ID.
- Delete PayrollPermanently delete one sensitive SmartHR payroll group by ID.
- Delete PayslipPermanently delete one sensitive SmartHR payslip from its payroll group.
- Delete Recruitment TypeDelete one SmartHR recruitment type by ID.
- Delete Tax WithholdingPermanently delete one sensitive SmartHR tax-withholding group by ID.
- Delete Tax Withholding SlipPermanently delete one sensitive SmartHR tax-withholding slip from its tax-withholding group.
- Delete User SAML ConfigurationDelete the SAML SSO account configuration for one SmartHR user.
- Delete WebhookPermanently delete one SmartHR webhook configuration by ID.
- Disable User SAML ConfigurationDisable the SAML SSO account configuration for one SmartHR user.
- Discontinue DepartmentIrreversibly discontinue one SmartHR department as of its final active date.
- Download Batch Job AttachmentDownload the binary file for a SmartHR batch-job attachment.
- Enable User SAML ConfigurationEnable the SAML SSO account configuration for one SmartHR user.
- Finalize PayrollFinalize one sensitive SmartHR payroll group.
- Invite EmployeeSend the documented SmartHR invitation to one employee's configured email address.
- Partially Update DepartmentPartially update a SmartHR department by ID.
- Partially Update Employee Custom Field TemplatePartially update an employee custom-field template.
- Partially Update Employment TypePartially update a SmartHR employment type by ID.
- Partially Update PayrollPartially update the administrator-facing and employee-facing names of a sensitive SmartHR payroll group by ID.
- Partially Update User SAML ConfigurationPartially update the SAML SSO account configuration for one SmartHR user.
- Partially Update WebhookPartially update a SmartHR webhook by ID.
- Publish PayrollIrreversibly publish one sensitive SmartHR payroll group immediately or at a scheduled time within one month, optionally notifying…
- Remove Employee DepartmentsRemove all department assignments from one employee using the documented SmartHR endpoint.
- Reopen PayrollReopen one sensitive SmartHR payroll group.
- Replace DepartmentReplace a SmartHR department through PUT.
- Replace Employee Custom Field TemplateReplace an employee custom-field template through the documented PUT operation.
- Replace Employee Custom Field Template GroupReplace an employee custom-field template group through the documented PUT operation.
- Replace Employment TypeReplace a SmartHR employment type through PUT.
- Replace GradeReplace a SmartHR grade by ID using full PUT semantics.
- Replace Job CategoryReplace a SmartHR job category by ID using full PUT semantics.
- Replace Job TitleReplace a SmartHR job title by ID using full PUT semantics.
- Replace Recruitment TypeReplace a SmartHR recruitment type by ID using full PUT semantics.
- Replace Tax WithholdingReplace a sensitive SmartHR tax-withholding group by ID using full PUT semantics.
- Replace WebhookReplace a SmartHR webhook through PUT.
- Start Dependent Import JobStart an asynchronous SmartHR dependent-data import from a Base64-encoded CSV or Excel file.
- Start Employee Export JobStart a SmartHR background job that exports employee information using an existing custom download format.
- Start Employee Import JobStart a SmartHR background job that inserts or updates employees from a sensitive base64-encoded CSV or Excel file.
- Update EmployeeUpdate the supplied documented fields of one employee by SmartHR employee ID.
- Update Employee Custom Field Template GroupUpdate one or more supplied fields of an employee custom-field template group.
- Update Employee DependentUpdate the supplied fields of one dependent belonging to an employee.
- Update GradeUpdate the supplied fields of a SmartHR grade by ID.
- Update Job CategoryUpdate the supplied fields of a SmartHR job category by ID.
- Update Job TitleUpdate the supplied fields of a SmartHR job title by ID.
- Update Recruitment TypeUpdate a SmartHR recruitment type by ID.
- Update Tax WithholdingUpdate the supplied fields of a sensitive SmartHR tax-withholding group by ID.
- Update Tax Withholding SlipUpdate a sensitive SmartHR tax-withholding slip.