/workable-recruiting | Type: Application | PCID required: Yes
Tools
workable_recruiting_approve_offer
Approve an offer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The offer ID. |
workable_recruiting_copy_candidate
Copy a candidate to another job Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The candidate’s ID. |
member_id | string | Yes | — | The member performing the copy. |
target_job_shortcode | string | Yes | — | The shortcode of the destination job. |
target_stage | string | No | — | The pipeline stage for the copied candidate. |
workable_recruiting_create_candidate
Create a candidate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
shortcode | string | Yes | — | The job’s shortcode. |
stage | string | No | — | Determines which stage the candidate is placed in. |
candidate | object | Yes | — | The candidate data object. |
sourced | boolean | No | — | Indicates if candidate is sourced (true) or applied (false). Defaults to true. |
workable_recruiting_create_candidate_comment
Comment on a candidate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The candidate’s ID. |
comment | object | Yes | — | The comment content. |
member_id | string | Yes | — | The member creating the comment. |
workable_recruiting_create_talent_pool_candidate
Create talent pool candidate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
stage | string | Yes | — | Candidate stage (e.g., ‘sourced’, ‘applied’). |
candidate | object | Yes | — | The candidate data object. |
sourced | boolean | No | — | Indicates if candidate is sourced (true) or applied (false). Defaults to true. |
workable_recruiting_disqualify_candidate
Disqualify a candidate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The candidate’s ID. |
disqualify_note | string | No | — | Additional info regarding disqualification (max 256 characters). |
disqualify_reason_id | string | No | — | The ID of the disqualification reason. |
member_id | string | Yes | — | The ID of the member performing the disqualification. |
withdrew | boolean | No | — | Disqualification category: true for withdrawal, false for rejection. |
workable_recruiting_get_candidate
Get a candidate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The candidate’s ID. |
workable_recruiting_get_job
Get a job Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
shortcode | string | Yes | — | The job’s shortcode. |
workable_recruiting_get_job_application_form
Get job application form Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
shortcode | string | Yes | — | The job’s shortcode. |
workable_recruiting_get_offer
Get an offer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The offer ID. |
workable_recruiting_list_candidates
List candidates Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | No | — | Filter candidates by email address. |
shortcode | string | No | — | Filter by the job’s shortcode. |
stage | string | No | — | Filter by job stage slug. |
limit | integer | No | — | Number of candidates per page. |
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 | — | Returns results created after this timestamp (ISO 8601). |
updated_after | string | No | — | Returns results updated after this timestamp (ISO 8601). |
workable_recruiting_list_job_activities
List job activities Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
shortcode | string | Yes | — | The job’s shortcode. |
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. |
workable_recruiting_list_job_questions
List job questions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
shortcode | string | Yes | — | The job’s shortcode. |
workable_recruiting_list_jobs
List jobs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
state | string | No | — | Filter by job state: draft, published, archived, closed. |
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 format). |
updated_after | string | No | — | Filter by update timestamp (ISO 8601 format). |
include_fields | string | No | — | Comma-separated list of additional fields to include: description, full_description, requirements, benefits. |
workable_recruiting_list_recruiters
List recruiters Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
shortcode | string | No | — | The job’s shortcode. If provided, only recruiters collaborating on the correlated job will be returned. |
workable_recruiting_list_stages
List stagesworkable_recruiting_move_candidate
Move a candidate to another stage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The candidate’s ID. |
fill_reserved_requisition | boolean | No | — | When true, uses candidate’s reserved requisition. Defaults to false. |
member_id | string | Yes | — | The member performing the move. |
target_stage | string | No | — | The stage the candidate should be moved to. |
workable_recruiting_reject_offer
Reject an offer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The offer ID. |
rejection_reason | string | No | — | An optional rejection reason. |
workable_recruiting_relocate_candidate
Relocate a candidate to another job Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The candidate’s ID. |
member_id | string | Yes | — | The member performing the relocation. |
target_job_shortcode | string | Yes | — | Shortcode of the job to move candidate to. |
target_stage | string | No | — | Stage where candidate should be moved. |
workable_recruiting_revert_candidate_disqualification
Revert candidate disqualification Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The candidate’s ID. |
member_id | string | Yes | — | The identifier of the member reverting the disqualification. |
workable_recruiting_update_candidate
Update a candidate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The candidate’s ID. |
body | object | No | — | Candidate fields to update. |

