Workable
API actions for the Workable integration.
Workable
Manage recruiting workflows with Workable's hiring platform.
Add a candidate note
Attach an internal note to a Workable candidate profile.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
candidate_id | string | Yes | The ID of the candidate you want to add the note to. |
note | string | Yes | The note to add to the candidate. |
visibility | string | No | Who can see the note, for example internal. |
Response
{
"comment": "mock_value",
"comment_id": "mock_value",
"status": "mock_value"
}Advance candidate stage
Move a candidate to a new pipeline stage in Workable.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
candidate_id | string | Yes | The Workable candidate ID to move. |
stage | string | Yes | The hiring stage to move the candidate to, for example screening or offer. |
reason | string | No | Optional reason for the stage change. |
Response
{
"candidate_id": "mock_value",
"stage": "mock_value",
"status": "mock_value"
}Create a candidate
Add a candidate to a Workable job with contact details and optional resume link.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
job_shortcode | string | Yes | The short code of the job to add the candidate to. You can find it in the job's web address. |
name | string | Yes | Full name of the candidate. |
email | string | Yes | Candidate email address. |
phone | string | No | Optional phone number for the candidate. |
resume_url | string | No | Optional URL to the candidate's resume file. |
cover_letter | string | No | Optional cover letter text for the candidate. |
headline | string | No | Optional headline or summary for the candidate. |
Response
{
"candidate": "mock_value",
"candidate_id": "mock_value",
"status": "mock_value"
}Get candidate details
Fetch the full profile for a Workable candidate by ID.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
candidate_id | string | Yes | The Workable candidate ID to fetch. |
Response
{
"candidate": "mock_value",
"status": "mock_value"
}Get job details
Look up the full details of a specific job in Workable.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
job_shortcode | string | Yes | The short code that identifies the job in Workable. You can find it in the job's web address. |
Response
{
"job": "mock_value",
"status": "mock_value"
}List jobs
List the job postings in your Workable account. You can filter by status.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
state | string | No | Filter jobs by status, for example published or archived. Leave blank to include all. |
include_fields | array | No | Extra details to include with each job, for example department or hiring manager. |
Response
{
"jobs": [
{}
],
"status": "mock_value",
"total": 1
}