> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Workable

> How to set up the Workable connector, plus the actions and events that are available.

![Workable](https://stackone-logos.com/api/workable/filled/svg)

v2.2.5[See changelog](https://docs.stackone.com/connectors/workable/changelog.md)

[70 actions](#actions) · [7 events](#events) · 1 auth method

ATS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/workable/guides/connector-profile/api-key.md)
>
> Uses a Workable API access token. The token expires on the date chosen when it is generated and has to be replaced then.

Optionally, configure receiving Events for Workable into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/workable/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/workable/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

r\_account

r\_candidates

r\_employees

r\_jobs

r\_offers

r\_requisitions

r\_timeoff

w\_candidates

w\_comments

w\_departments

w\_employees

w\_members

w\_offers

w\_requisitions

w\_timeoff

No scopes found

70 actions

ActionDescriptionRequired scopes

List Accounts`workable_list_accounts`

Get all accounts accessible by user

`r_jobs`

Get Account Details`workable_get_account`

Get detailed information about a specific account

`r_jobs`

List Permission Sets`workable_list_permission_sets`

Get all permission sets in the account

`r_account`

List Legal Entities`workable_list_legal_entities`

Get all legal entities configured in the account

`r_account`

List Disqualification Reasons`workable_list_disqualification_reasons`

Get all disqualification reasons

`r_jobs`

List Candidates`workable_list_candidates`

Get all candidates across all jobs

`r_candidates`

Get Candidate`workable_get_candidate`

Get detailed information about a specific candidate

`r_candidates`

Create Job Candidate`workable_create_job_candidate`

Create a new candidate for a specific job

`w_candidates`

Create Talent Pool Candidate`workable_create_talent_pool_candidate`

Create a new candidate in the talent pool

`w_candidates`

Update Candidate`workable_update_candidate`

Update candidate information

`w_candidates`

Get Candidate Activities`workable_get_candidate_activities`

Get activity timeline for a candidate

`r_candidates`

Get Candidate Files`workable_get_candidate_files`

Get files associated with a candidate

Get Candidate Offer`workable_get_candidate_offer`

Get offer details for a candidate

`r_candidates`

Comment On Candidate`workable_comment_on_candidate`

Add a comment to candidate's profile

`w_comments`

Tag Candidate`workable_tag_candidate`

Add or remove tags from candidate

`w_candidates`

Disqualify Candidate`workable_disqualify_candidate`

Disqualify a candidate

`w_candidates`

Revert Candidate Disqualification`workable_revert_candidate`

Revert a candidate's disqualification

`w_candidates`

Copy Candidate`workable_copy_candidate`

Copy candidate to another job

`w_candidates`

Relocate Candidate`workable_relocate_candidate`

Move candidate to another job

`w_candidates`

Move Candidate To Stage`workable_move_candidate`

Move candidate to a different stage

`w_candidates`

Rate Candidate`workable_rate_candidate`

Add a rating to candidate

`w_candidates`

Update Candidate Custom Attribute`workable_update_candidate_custom_attribute`

Update a custom attribute value for candidate

`r_jobs`

List Members`workable_list_members`

Get all members in the account

`r_jobs`

Update Member`workable_update_member`

Update an existing member's roles and collaboration rules

`w_members`

Invite Member`workable_invite_member`

Invite a new member to the account

`w_members`

Delete Member`workable_delete_member`

Deactivate a member in the account

`w_members`

Enable Member`workable_enable_member`

Restore a previously deactivated member

`w_members`

List Recruiters`workable_list_recruiters`

Get all external recruiters in the account

`r_jobs`

List Stages`workable_list_stages`

Get all recruitment pipeline stages

`r_jobs`

List Departments`workable_list_departments`

Get all departments

`r_account`

Create Department`workable_create_department`

Create a new department

`w_departments`

Update Department`workable_update_department`

Update an existing department

`w_departments`

Merge Departments`workable_merge_departments`

Merge a department into another

`w_departments`

Delete Department`workable_delete_department`

Delete a department

`w_departments`

List Requisitions`workable_list_requisitions`

Get all requisitions

`r_requisitions`

Get Requisition`workable_get_requisition`

Get a specific requisition by code

`r_requisitions`

Create Requisition`workable_create_requisition`

Create a new requisition

`w_requisitions`

Update Requisition`workable_update_requisition`

Update an existing requisition

`w_requisitions`

Approve Requisition`workable_approve_requisition`

Approve a requisition

`w_requisitions`

Reject Requisition`workable_reject_requisition`

Reject a requisition

`w_requisitions`

Get Offer`workable_get_offer`

Get a specific offer by ID

`r_offers`

Approve Offer`workable_approve_offer`

Approve an offer (must be in a compatible state)

`w_offers`

Reject Offer`workable_reject_offer`

Reject an offer (must be in a compatible state)

`w_offers`

List Jobs`workable_list_jobs`

Get all jobs in the account

`r_jobs`

Get Job`workable_get_job`

Get detailed information about a specific job

`r_jobs`

Get Job Activities`workable_get_job_activities`

Get activity stream for a job

`r_candidates`

Get Job Application Form`workable_get_job_application_form`

Get application form details for a job

`r_jobs`

Get Job Questions`workable_get_job_questions`

Get questions for a job

`r_jobs`

Get Job Stages`workable_get_job_stages`

Get recruitment pipeline stages for a job

`r_jobs`

Get Job Custom Attributes`workable_get_job_custom_attributes`

Get custom attributes for a job

`r_jobs`

Get Job Members`workable_get_job_members`

Get members in the hiring team for a job

`r_jobs`

Get Job Recruiters`workable_get_job_recruiters`

Get external recruiters for a job

`r_jobs`

List Custom Attributes`workable_list_custom_attributes`

Get all custom attributes

`r_jobs`

List Events`workable_list_events`

Get all scheduled events

`r_jobs`

Get Event`workable_get_event`

Get detailed information about a specific event

`r_jobs`

List Employees`workable_list_employees`

Get all employees

`r_employees`

Get Employee`workable_get_employee`

Get detailed information about a specific employee

`r_employees`

List Employee Fields`workable_list_employee_fields`

Get all employee field configurations

`r_account`

Get Employee Documents`workable_get_employee_documents`

Get all documents for an employee

`r_employees`

List Work Schedules`workable_list_work_schedules`

Get all work schedule configurations

`r_account`

Create Employee`workable_create_employee`

Create a new employee record

`w_employees`

Update Employee`workable_update_employee`

Update an existing employee record

`w_employees`

Create Employee Document`workable_create_employee_document`

Upload a document for an employee

`w_employees`

List Time Off Categories`workable_list_timeoff_categories`

Get all time off categories

`r_timeoff`

Create Time Off Request`workable_create_timeoff_request`

Create a new time off request for an employee

`w_timeoff`

List Time Off Requests`workable_list_timeoff_requests`

Get all time off requests

`r_timeoff`

List Time Off Balances`workable_list_timeoff_balances`

Get time off balances for employees

`r_timeoff`

List Webhook Subscriptions`workable_list_subscriptions`

Get all webhook subscriptions

`r_candidates`

Create Webhook Subscription`workable_create_subscription`

Create a new webhook subscription

`r_candidates`

Delete Webhook Subscription`workable_delete_subscription`

Delete a webhook subscription

`r_candidates`

## Events

Tags

Select all
|
Clear

Candidates

Employees

Time Off

Webhooks

No tags found

7 events

EventDescriptionTags

Candidate Created Webhook`workable_webhook_candidate_created`

Processes Workable candidate\_created events.

CandidatesWebhooks

Candidate Moved Webhook`workable_webhook_candidate_moved`

Processes Workable candidate\_moved events (a candidate advancing to a new stage).

CandidatesWebhooks

Employee Created Webhook`workable_webhook_employee_created`

Processes Workable employee\_created events.

EmployeesWebhooks

Employee Updated Webhook`workable_webhook_employee_updated`

Processes Workable employee\_updated events.

EmployeesWebhooks

Employee Published Webhook`workable_webhook_employee_published`

Processes Workable employee\_published events.

EmployeesWebhooks

Onboarding Completed Webhook`workable_webhook_onboarding_completed`

Processes Workable onboarding\_completed events.

EmployeesWebhooks

Time Off Updated Webhook`workable_webhook_timeoff_updated`

Processes Workable time off events (subscribed as timeoff\_updated; delivered as timeoff\_request\_approved / timeoff\_reque...

Time OffWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.