Getting started

API access to your recruiting data

Need to display your positions in different ways, or to extract additional information from your Workable account? We provide you with an API that gives you full control over your data.

The Workable API can be used in the following ways:

• Extract information about your:
  • account
  • hiring members and recruiters
  • pipeline stages
  • jobs and questions
  • scheduled events
  • job's and/or candidate's activity
• Manage your candidates by:
  • Fetching candidates
  • Extracting detail candidate info
  • Creating candidates
  • Updating candidates
  • Execute various actions on candidates e.g. copy, relocate or disqualify
  • Adding comments or ratings
• Manage your employees by:
  • Listing your /employees
  • Getting information about a specific /employees/:id
  • Creating a specific /employees
  • Updating a specific /employees/:id
  • Getting documents about a specific employee /employees/:id/documents
  • Creating documents for a specific employee /employees/:id/documents
• Retrieve information about your account by:
  • Listing your /departments
  • Listing your /work_schedules
  • Listing your /employee_fields
  • Listing your configured /legal_entities

Currently we do not support the following:

• Viewing candidates in the Talent pool

🚧

Notes

• Workable does not support Cross-Origin Resource Sharing (CORS)
• The resource IDs exposed in the API are not the same as in the application for non-disclosure reasons

Generate an API access token

This guide shows how to generate an API access token for your Workable account.

To start, open the drop-down menu on the top right of your screen and select “Integrations” or press here:

Now click on the “Generate new token” button:

Once you click the generate button, you’ll see the Generate API token form where you should specify the relevant scopes for your use case:

🚧

There are some scopes like the r_employees scope, grant access to confidential employee data.

🚧

It is imperative to securely store a copy of the token upon generation, as it will be displayed only a single time. In the event that the token is not securely stored, it is advisable to generate a new one.

For more information on selecting scopes please refer to this.

If you're using Mac OS X or Linux, test it on the spot just by typing the following command in your terminal window (remember to replace the ‘account subdomain’):

Shell

curl -H "Authorization:Bearer <ACCESS TOKEN>" 
     https://<account subdomain>.workable.com/spi/v3/jobs

You will also need the account subdomain which you can find in the company profile settings page:

❗️

Revoking The Access Token

Be aware that you can revoke this access token anytime, but if you decide to proceed, every script or application that accesses the Workable API through this token will stop functioning. To keep things running smoothly after revoking your current token, you will have to generate a new access token and update every script or application bound to the previous one.