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

Tools


workable_recruiting_approve_offer

Approve an offer Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe offer ID.

workable_recruiting_copy_candidate

Copy a candidate to another job Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe candidate’s ID.
member_idstringYesThe member performing the copy.
target_job_shortcodestringYesThe shortcode of the destination job.
target_stagestringNoThe pipeline stage for the copied candidate.

workable_recruiting_create_candidate

Create a candidate Parameters:
ParameterTypeRequiredDefaultDescription
shortcodestringYesThe job’s shortcode.
stagestringNoDetermines which stage the candidate is placed in.
candidateobjectYesThe candidate data object.
sourcedbooleanNoIndicates if candidate is sourced (true) or applied (false). Defaults to true.

workable_recruiting_create_candidate_comment

Comment on a candidate Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe candidate’s ID.
commentobjectYesThe comment content.
member_idstringYesThe member creating the comment.

workable_recruiting_create_talent_pool_candidate

Create talent pool candidate Parameters:
ParameterTypeRequiredDefaultDescription
stagestringYesCandidate stage (e.g., ‘sourced’, ‘applied’).
candidateobjectYesThe candidate data object.
sourcedbooleanNoIndicates if candidate is sourced (true) or applied (false). Defaults to true.

workable_recruiting_disqualify_candidate

Disqualify a candidate Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe candidate’s ID.
disqualify_notestringNoAdditional info regarding disqualification (max 256 characters).
disqualify_reason_idstringNoThe ID of the disqualification reason.
member_idstringYesThe ID of the member performing the disqualification.
withdrewbooleanNoDisqualification category: true for withdrawal, false for rejection.

workable_recruiting_get_candidate

Get a candidate Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe candidate’s ID.

workable_recruiting_get_job

Get a job Parameters:
ParameterTypeRequiredDefaultDescription
shortcodestringYesThe job’s shortcode.

workable_recruiting_get_job_application_form

Get job application form Parameters:
ParameterTypeRequiredDefaultDescription
shortcodestringYesThe job’s shortcode.

workable_recruiting_get_offer

Get an offer Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe offer ID.

workable_recruiting_list_candidates

List candidates Parameters:
ParameterTypeRequiredDefaultDescription
emailstringNoFilter candidates by email address.
shortcodestringNoFilter by the job’s shortcode.
stagestringNoFilter by job stage slug.
limitintegerNoNumber of candidates per page.
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_afterstringNoReturns results created after this timestamp (ISO 8601).
updated_afterstringNoReturns results updated after this timestamp (ISO 8601).

workable_recruiting_list_job_activities

List job activities Parameters:
ParameterTypeRequiredDefaultDescription
shortcodestringYesThe job’s shortcode.
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.

workable_recruiting_list_job_questions

List job questions Parameters:
ParameterTypeRequiredDefaultDescription
shortcodestringYesThe job’s shortcode.

workable_recruiting_list_jobs

List jobs Parameters:
ParameterTypeRequiredDefaultDescription
statestringNoFilter by job state: draft, published, archived, closed.
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 format).
updated_afterstringNoFilter by update timestamp (ISO 8601 format).
include_fieldsstringNoComma-separated list of additional fields to include: description, full_description, requirements, benefits.

workable_recruiting_list_recruiters

List recruiters Parameters:
ParameterTypeRequiredDefaultDescription
shortcodestringNoThe job’s shortcode. If provided, only recruiters collaborating on the correlated job will be returned.

workable_recruiting_list_stages

List stages

workable_recruiting_move_candidate

Move a candidate to another stage Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe candidate’s ID.
fill_reserved_requisitionbooleanNoWhen true, uses candidate’s reserved requisition. Defaults to false.
member_idstringYesThe member performing the move.
target_stagestringNoThe stage the candidate should be moved to.

workable_recruiting_reject_offer

Reject an offer Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe offer ID.
rejection_reasonstringNoAn optional rejection reason.

workable_recruiting_relocate_candidate

Relocate a candidate to another job Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe candidate’s ID.
member_idstringYesThe member performing the relocation.
target_job_shortcodestringYesShortcode of the job to move candidate to.
target_stagestringNoStage where candidate should be moved.

workable_recruiting_revert_candidate_disqualification

Revert candidate disqualification Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe candidate’s ID.
member_idstringYesThe identifier of the member reverting the disqualification.

workable_recruiting_update_candidate

Update a candidate Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe candidate’s ID.
bodyobjectNoCandidate fields to update.