How do I get my API from Workable and connect to RecruiterCloud?

To authenticate your Workable account, you will need to provide the following information:

• Subdomain
• API Key

This guide will walk you through finding or creating those credentials within Workable.

1. Click here to go to your ATS page.
2. In the top right corner, press 'Connect ATS'

3. You can search for Workable in the pop-out window and select 'Workable' from the options.

4. Select 'Use my API key or access token (recommended)'

   

5. Confirm that you are admin at the bottom of the next page.

6. Review the permissions required for the integration.

7. Add your subdomain for your Workable account. For example, if you sign in at "acme.workable.com", enter "acme".Do not enter the full "acme.workable.com".
8. Press 'Next'

9. Log in to your Workable portal via your organization’s tenant URL

10. Click on your profile icon in the upper right-hand corner of any page to open up the dropdown menu. Click 'Settings'

    ​

    

    
    

11. Click 'Integrations' in the left menu

    

12. Go to the 'Access Token 'section on the page. If you do not have an API key created yet, click 'Generate new token'

    

13. Configure 'Scopes'. If you want to limit the scopes that Merge has access to, please make sure these are added so that Merge is able to sync data for the account. These are the minimum scopes required:
    • r_candidates

    • r_jobs

      You may need additional scopes depending on your use case, for example you will need w_candidates if you plan to POST/create candidates

      
      

14. Retrieve your 'API key'

    

14. Provide the information manually into the flow or provide it to your CSM if using Autopilot

• If using Autopilot, provide the company-name of your Workable account and the API key to your CSM via email.

15. Add to ATS settings manually: Back in the linking flow, enter the subdomain that appears when you log into Workable. For example, for company-name.workable.com, please enter company-name. Do not enter the full {companydomain}.workable.com

15. Enter the API key you retrieved from step 1.6 above.

    

3. Press 'Next' to complete the connection.