Connecting to Workable

Using API Key Authentication

Workable uses API key authentication to control access to the API. To obtain an API Key:

Log in to your Workable account.
Navigate to Settings > Integrations > API Access Tokens.
Click "Generate API Token".
Copy the generated token.

After obtaining your API Key, set the following connection properties:

AuthScheme: Set this to APIKey.

Set the following in the ProfileSettings connection property:

APIKey: Set this to your Workable API Key.
Subdomain: Set this to your Workable account subdomain. For example, if your Workable URL is acmeinc.workable.com, then the Subdomain is 'acmeinc'.

Example Connection String

Profile=C:\profiles\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';

Available Tables

The Workable API Profile provides access to the following tables:

Accounts: Returns the list of Workable accounts accessible by the authenticated API key.
CandidateActivities: Returns the activity history for a specific candidate (requires CandidateId).
Candidates: Returns a list of candidates or retrieves a specific candidate by Id.
CustomAttributes: Returns the list of custom candidate attributes defined for the account.
Departments: Returns the list of departments for the Workable account.
DisqualificationReasons: Returns the list of disqualification reasons configured for the account.
Events: Returns a list of scheduled events or retrieves a specific event by Id.
JobActivities: Returns the activity feed for a specific job (requires JobShortcode).
JobCandidates: Returns a list of candidates for a specific job (requires JobShortcode).
JobMembers: Returns the team members assigned to a specific job (requires JobShortcode).
JobQuestions: Returns the application questions configured for a specific job (requires JobShortcode).
Jobs: Returns a list of jobs or retrieves a specific job by Shortcode.
JobStages: Returns the pipeline stage configuration for a specific job (requires JobShortcode).
Members: Returns the list of team members for the Workable account.
Stages: Returns the global pipeline stage configurations for the account.
Subscriptions: Returns the list of webhook subscriptions configured for the account.

Important Notes

The Subdomain connection property is required and must be set to your Workable account subdomain.
Several tables require a parent identifier (e.g. JobShortcode, CandidateId) to be specified as a WHERE clause filter.
List endpoints use cursor-based pagination via a next-page URL returned in the paging response field.
Date fields use ISO 8601 format (yyyy-MM-dd'T'HH:mm:ssZ).

API Documentation

For more information about the Workable API, see the official Workable API documentation.

Usage Examples

Accounts:

SELECT * FROM Accounts

Jobs:

SELECT Shortcode, Title, State FROM Jobs

Jobs (single record):

SELECT * FROM Jobs WHERE Shortcode = 'E5829F552E'

Candidates:

SELECT * FROM Candidates

Members:

SELECT * FROM Members

Departments:

SELECT * FROM Departments

Stages:

SELECT * FROM Stages

Events:

SELECT * FROM Events

Subscriptions:

SELECT * FROM Subscriptions

DisqualificationReasons:

SELECT * FROM DisqualificationReasons

CustomAttributes:

SELECT * FROM CustomAttributes

JobCandidates:

SELECT * FROM JobCandidates WHERE JobShortcode = 'E5829F552E'

JobStages:

SELECT * FROM JobStages WHERE JobShortcode = 'E5829F552E'

JobMembers:

SELECT * FROM JobMembers WHERE JobShortcode = 'E5829F552E'

JobQuestions:

SELECT * FROM JobQuestions WHERE JobShortcode = 'E5829F552E'

JobActivities:

SELECT * FROM JobActivities WHERE JobShortcode = 'E5829F552E'

CandidateActivities:

SELECT * FROM CandidateActivities WHERE CandidateId = 'candidate-id'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

Property	Description
APIKey	Your Workable API Key.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT
Subdomain	Your Workable subdomain.