Workable | Obtaining your API token

This article provides guidance on creating an API access token to link your Workable account to Oyster.

Prerequisites

  • You have Admin access to your company's account.
  • You are logged in to the Oyster Platform with your admin credentials.
  • You are logged in to Workable as an Administrator.

Steps

  1. Log in to Workable.
  2. Copy and save the base URL of your Workable instance. You will need to enter this information later in Oyster's platform. In this example, the base URL is merge-api-testing.
Obtaining your API token - Step 1.png
  1. Click on your profile icon in the upper right-hand corner to open up the dropdown menu. Click Settings.
Obtaining your API token - Step 3.png
  1. In the left menu, click Apps under Integrations.
Obtaining your API token - Step 4.png
  1. Scroll down to API ACCESS TOKENS and click Generate API token.
Obtaining your API token - Step 5.png
  1. Enter the name of your API key.
  2. Select the following scopes:
    • r_candidates
    • r_jobs
  3. Click Generate token.
Obtaining your API token - Step 6.png
  1. Your API token has been successfully created! Use the icon to copy and save it somewhere safe, as you will not have access to it after closing this modal. 
Obtaining your API token - Step 9.png

You can now go to Connecting to Oyster and complete the remaining steps on the Oyster platform. 

Was this article helpful?

0 out of 0 found this helpful