/workable-hr | Type: Application | PCID required: Yes
Tools
workable_hr_approve_requisition
Approve a requisition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
code | string | Yes | — | The requisition code. |
member_id | string | Yes | — | The member approving the requisition. |
workable_hr_create_department
Create a department Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Department name. |
parent_id | string | No | — | Parent department identifier. |
workable_hr_create_employee
Create an employee Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
member_id | string | No | — | Optional member ID, retrievable from GET /members. |
workable_hr_create_requisition
Create a requisition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
city | string | No | — | City. |
code | object | Yes | — | The requisition code. |
country_code | string | No | — | Country code. |
department_id | string | No | — | Department ID. |
employment_type | string | No | — | Employment type. |
experience | string | No | — | Experience level. |
hiring_manager_id | string | Yes | — | Hiring manager ID. |
job_id | string | No | — | Job ID. |
job_title | string | Yes | — | Job title. |
member_id | string | No | — | Creator ID (required for account tokens). |
notes | string | No | — | Additional notes. |
owner_id | string | Yes | — | Owner identifier. |
plan_date | string | Yes | — | Plan date. |
reason | string | No | — | Reason for the requisition. |
salary_currency | string | No | — | Salary currency. |
salary_frequency | string | No | — | Salary frequency. |
salary_from | number | No | — | Minimum salary. |
salary_to | number | No | — | Maximum salary. |
workable_hr_create_subscription
Create a webhook subscription Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
args | object | No | — | Arguments for the subscription. |
event | string | Yes | — | The event to subscribe to. |
target | string | Yes | — | The URL of the endpoint to push notifications at. |
workable_hr_deactivate_member
Deactivate a member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The member’s ID. |
workable_hr_delete_department
Delete a department Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Department ID. |
force | string | No | — | Pass ‘DELETE’ to bypass affected resource checks. |
workable_hr_enable_member
Enable a member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The member’s ID. |
workable_hr_get_employee
Get an employee Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The employee ID. |
member_id | string | No | — | Optional member ID for user tokens; required for account tokens. |
workable_hr_get_requisition
Get a requisition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
code | string | Yes | — | The requisition code. |
workable_hr_invite_member
Invite a member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
collaboration_rules | object[] | No | — | Collaboration rules for the member. |
email | string | Yes | — | The email address to invite. |
member_id | string | No | — | Required for account-wide tokens. |
roles | string[] | Yes | — | The roles to assign to the member. |
workable_hr_list_accounts
List accountsworkable_hr_list_departments
List departmentsworkable_hr_list_employee_fields
List employee fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
member_id | string | No | — | Optional member ID derived from GET /members. |
workable_hr_list_employees
List employees Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Limits number of returned results. Must be one of: 10, 20, 50, 100. Default: 10. |
offset | integer | No | — | Skips first n entries for pagination. |
query | string | No | — | Search by firstname, lastname, or email. |
order_by | string | No | — | Order results by division or department. |
member_id | string | No | — | Elevated access identifier from GET /members. |
workable_hr_list_legal_entities
List legal entitiesworkable_hr_list_members
List members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results per page (default 50). |
since_id | string | No | — | Returns results with an ID greater than or equal to the specified ID. |
max_id | string | No | — | Returns results with an ID less than or equal to the specified ID. |
role | string | No | — | Filter by role: simple, admin, or reviewer. |
shortcode | string | No | — | Filter by specific job shortcode. |
email | string | No | — | Filter by member email. |
name | string | No | — | Filter by full name (exact match). |
status | string | No | — | Filter by status: active, inactive, all. Default: active. |
workable_hr_list_requisitions
List requisitions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
state | string | No | — | Filter by requisition state. |
job_id | string | No | — | Filter by job ID. |
plan_date_from | string | No | — | Filter plan date from (YYYY-MM format). |
plan_date_to | string | No | — | Filter plan date to (YYYY-MM format). |
limit | integer | No | — | Number of results per page (default 50). |
since_id | string | No | — | Returns results with an ID greater than or equal to the specified ID. |
max_id | string | No | — | Returns results with an ID less than or equal to the specified ID. |
created_after | string | No | — | Filter by creation timestamp (ISO 8601). |
updated_after | string | No | — | Filter by update timestamp (ISO 8601). |
workable_hr_list_work_schedules
List work schedulesworkable_hr_merge_departments
Merge departments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The department ID to merge from. |
force | boolean | No | — | Bypass affected resource checks when true. |
target_department_id | string | Yes | — | Target department identifier. |
workable_hr_reject_requisition
Reject a requisition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
code | string | Yes | — | The requisition code. |
member_id | string | Yes | — | The member rejecting the requisition. |
rejection_reason | string | No | — | An optional rejection reason. |
workable_hr_update_department
Update a department Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Department identifier. |
name | string | Yes | — | New department name. |
parent_id | string | No | — | Parent department identifier. |
workable_hr_update_employee
Update an employee Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The employee ID. |
member_id | string | No | — | Optional member ID, retrievable from GET /members. |
workable_hr_update_member
Update a member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
collaboration_rules | object[] | No | — | Rules with role, departments, and locations. |
id | string | Yes | — | The member’s identifier. |
roles | string[] | Yes | — | Member’s roles in the system. |
workable_hr_update_requisition
Update a requisition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The requisition ID. |
hiring_manager_id | string | No | — | Hiring manager ID. |
job_title | string | No | — | Job title. |
member_id | string | No | — | Editor ID (required for account tokens). |
owner_id | string | No | — | Owner identifier. |
plan_date | string | No | — | Plan date. |

