Skip to main content
Server path: /workable-hr | Type: Application | PCID required: Yes

Tools


workable_hr_approve_requisition

Approve a requisition Parameters:
ParameterTypeRequiredDefaultDescription
codestringYesThe requisition code.
member_idstringYesThe member approving the requisition.

workable_hr_create_department

Create a department Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesDepartment name.
parent_idstringNoParent department identifier.

workable_hr_create_employee

Create an employee Parameters:
ParameterTypeRequiredDefaultDescription
member_idstringNoOptional member ID, retrievable from GET /members.

workable_hr_create_requisition

Create a requisition Parameters:
ParameterTypeRequiredDefaultDescription
citystringNoCity.
codeobjectYesThe requisition code.
country_codestringNoCountry code.
department_idstringNoDepartment ID.
employment_typestringNoEmployment type.
experiencestringNoExperience level.
hiring_manager_idstringYesHiring manager ID.
job_idstringNoJob ID.
job_titlestringYesJob title.
member_idstringNoCreator ID (required for account tokens).
notesstringNoAdditional notes.
owner_idstringYesOwner identifier.
plan_datestringYesPlan date.
reasonstringNoReason for the requisition.
salary_currencystringNoSalary currency.
salary_frequencystringNoSalary frequency.
salary_fromnumberNoMinimum salary.
salary_tonumberNoMaximum salary.

workable_hr_create_subscription

Create a webhook subscription Parameters:
ParameterTypeRequiredDefaultDescription
argsobjectNoArguments for the subscription.
eventstringYesThe event to subscribe to.
targetstringYesThe URL of the endpoint to push notifications at.

workable_hr_deactivate_member

Deactivate a member Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe member’s ID.

workable_hr_delete_department

Delete a department Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesDepartment ID.
forcestringNoPass ‘DELETE’ to bypass affected resource checks.

workable_hr_enable_member

Enable a member Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe member’s ID.

workable_hr_get_employee

Get an employee Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe employee ID.
member_idstringNoOptional member ID for user tokens; required for account tokens.

workable_hr_get_requisition

Get a requisition Parameters:
ParameterTypeRequiredDefaultDescription
codestringYesThe requisition code.

workable_hr_invite_member

Invite a member Parameters:
ParameterTypeRequiredDefaultDescription
collaboration_rulesobject[]NoCollaboration rules for the member.
emailstringYesThe email address to invite.
member_idstringNoRequired for account-wide tokens.
rolesstring[]YesThe roles to assign to the member.

workable_hr_list_accounts

List accounts

workable_hr_list_departments

List departments

workable_hr_list_employee_fields

List employee fields Parameters:
ParameterTypeRequiredDefaultDescription
member_idstringNoOptional member ID derived from GET /members.

workable_hr_list_employees

List employees Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoLimits number of returned results. Must be one of: 10, 20, 50, 100. Default: 10.
offsetintegerNoSkips first n entries for pagination.
querystringNoSearch by firstname, lastname, or email.
order_bystringNoOrder results by division or department.
member_idstringNoElevated access identifier from GET /members.

List legal entities

workable_hr_list_members

List members Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoNumber of results per page (default 50).
since_idstringNoReturns results with an ID greater than or equal to the specified ID.
max_idstringNoReturns results with an ID less than or equal to the specified ID.
rolestringNoFilter by role: simple, admin, or reviewer.
shortcodestringNoFilter by specific job shortcode.
emailstringNoFilter by member email.
namestringNoFilter by full name (exact match).
statusstringNoFilter by status: active, inactive, all. Default: active.

workable_hr_list_requisitions

List requisitions Parameters:
ParameterTypeRequiredDefaultDescription
statestringNoFilter by requisition state.
job_idstringNoFilter by job ID.
plan_date_fromstringNoFilter plan date from (YYYY-MM format).
plan_date_tostringNoFilter plan date to (YYYY-MM format).
limitintegerNoNumber of results per page (default 50).
since_idstringNoReturns results with an ID greater than or equal to the specified ID.
max_idstringNoReturns results with an ID less than or equal to the specified ID.
created_afterstringNoFilter by creation timestamp (ISO 8601).
updated_afterstringNoFilter by update timestamp (ISO 8601).

workable_hr_list_work_schedules

List work schedules

workable_hr_merge_departments

Merge departments Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe department ID to merge from.
forcebooleanNoBypass affected resource checks when true.
target_department_idstringYesTarget department identifier.

workable_hr_reject_requisition

Reject a requisition Parameters:
ParameterTypeRequiredDefaultDescription
codestringYesThe requisition code.
member_idstringYesThe member rejecting the requisition.
rejection_reasonstringNoAn optional rejection reason.

workable_hr_update_department

Update a department Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesDepartment identifier.
namestringYesNew department name.
parent_idstringNoParent department identifier.

workable_hr_update_employee

Update an employee Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe employee ID.
member_idstringNoOptional member ID, retrievable from GET /members.

workable_hr_update_member

Update a member Parameters:
ParameterTypeRequiredDefaultDescription
collaboration_rulesobject[]NoRules with role, departments, and locations.
idstringYesThe member’s identifier.
rolesstring[]YesMember’s roles in the system.

workable_hr_update_requisition

Update a requisition Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe requisition ID.
hiring_manager_idstringNoHiring manager ID.
job_titlestringNoJob title.
member_idstringNoEditor ID (required for account tokens).
owner_idstringNoOwner identifier.
plan_datestringNoPlan date.