Skip to main content

At a glance

Credentials

Set these per environment. See Connect an integration.
VariableRequiredDescription
WORKABLE_API_TOKENYesWorkable API access token, generated under Settings → Integrations → Apps → Generate new token Docs.
WORKABLE_SUBDOMAINYesYour Workable account subdomain ({subdomain}.workable.com), shown in your company profile settings Docs.

Setup

  1. Get a Workable account: Sign up at https://www.workable.com - a 15-day free trial account is enough for testing the API against your own data.
  2. Generate an access token: In Workable, open the top-right dropdown menu → Integrations, then click ‘Generate new token’. Select the scopes you need (r_jobs and r_candidates for reads; w_candidates for comments and stage moves). The token is shown only once - copy it immediately.
  3. Find your subdomain: Your account subdomain is the {subdomain} part of {subdomain}.workable.com and is shown on your company profile settings page.
  4. Store the credentials: Add WORKABLE_API_TOKEN=<your token> and WORKABLE_SUBDOMAIN=<your subdomain> to your .env file. Requests go to https://{subdomain}.workable.com/spi/v3 with an Authorization: Bearer header.
  • Tokens are scoped at generation time - writes need w_candidates (comments also accept w_comments)
  • Revoking a token breaks every script using it; generate a new one and update all consumers
  • List endpoints paginate via the paging.next URL and since_id cursors (max 100 per page)
Provider API reference: https://workable.readme.io/reference

Tools

ToolAccessDescription
List JobsReadList jobs in the Workable account with optional state filtering
Get JobReadGet the full details of a job by its shortcode
List CandidatesReadList candidates account-wide or for a specific job (filter by job shortcode, stage, or email)
Get CandidateReadGet the full profile of a candidate by ID, including stage, answers, and attachments
List MembersReadList account members to find the member IDs required by the comment and move-candidate tools
List StagesReadList the recruitment pipeline stages to find stage slugs for candidate filtering and moves
Create CandidateWriteAdd a candidate to a job, either as sourced or as having applied
Create Candidate CommentWritePost a comment on a candidate’s timeline on behalf of a team member
Move CandidateWriteMove a candidate to another pipeline stage on behalf of a team member

Example prompts

  • List my published jobs in Workable and summarize how many candidates are in each pipeline.
  • Show me the candidates currently in the interview stage for a job I specify and summarize their profiles.
  • Look up a candidate I specify in Workable and add a comment to their timeline with my feedback.