All Collections
Authentication Guides
Workable - API Key Authentication
Workable - API Key Authentication

Subdomain + API Key

Pritak Patel avatar
Written by Pritak Patel
Updated over a week ago


Enter the Workable subdomain that appears when you log into Workable.

For example, for, please enter company-name. Do not enter the full {companydomain}

API Key:

1. Log in and click on your profile icon in the upper right-hand corner of any page to open up the dropdown menu. Click Settings.

2. Click Integrations in the left menu.

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

4. 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.

5. Copy the API key.

6. Paste the API key into Merge Link and click submit.

Did this answer your question?