Skip to main content

Workable

Workable is a recruiting and applicant tracking system (ATS) that helps teams source, evaluate, and hire candidates. Its REST API exposes jobs, candidates, hiring pipeline stages, recruiters, and account data such as members, departments, and requisitions. Nexla connects to the Workable API to ingest this recruiting data and to write candidates, comments, and stage changes back into your Workable account.

Workable icon

Power end-to-end data operations for your Workable API with Nexla. Our bi-directional Workable connector is purpose-built for Workable, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Workable or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Workable workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Workable credential, you need a Workable API access token and your account's API base URL. Workable uses Bearer token authentication, with the token sent in the Authorization: Bearer <ACCESS_TOKEN> header on every request.

To obtain your Workable credentials, follow these steps:

  1. Sign in to your Workable account with an administrator or account owner role.

  2. Open your account settings and navigate to the Integrations section (Settings > Integrations), where API access tokens are managed.

  3. Click Generate new token, then select the scopes appropriate for your use case (for example, read access to jobs and candidates, and write access if you plan to create or update candidates).

  4. Generate the token and copy it immediately. Workable displays the token only once, so store it securely; if you lose it you must generate a new one.

  5. Determine your account subdomain from your company profile settings. Your API base URL follows the pattern https://<account-subdomain>.workable.com/spi/v3, where <account-subdomain> is replaced with your account's subdomain.

Keep the access token confidential. Revoking a token immediately breaks any application using it, so if a token is compromised, generate a new one and update your Nexla credential. For detailed information about authentication and available endpoints, see the Workable API documentation.

Authenticate

Credentials required

FieldRequiredSecretDescription
API KeyYesYesWorkable API access token used to authenticate requests.
Base URLYesNoAPI base URL.

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your Workable API access token in the API Key field. This token is sent in the Authorization: Bearer <ACCESS_TOKEN> header on every request to the Workable API and must be kept confidential.

  4. Enter your Workable API base URL in the Base URL field. This is your account-specific endpoint, following the pattern https://<account-subdomain>.workable.com/spi/v3, where <account-subdomain> is your account's subdomain.

    If your access token is compromised, revoke it in your Workable Integrations settings and generate a new one, then update this credential. Revoking a token immediately breaks any application still using it.

    For detailed information about authentication, base URLs, and available endpoints, see the Workable API documentation.

  5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Workable connector tile, then select the credential that will be used to connect to Workable, and click Next; or, create a new Workable credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Workable endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Jobs

This endpoint template retrieves jobs from your Workable account. Use this template when you need to access job postings, their status, and related metadata for analysis, reporting, or integration purposes.

For detailed information about jobs and available fields, see the Workable API documentation.

[Rest API] List Candidates

This endpoint template retrieves candidates from your Workable account. Use this template when you need to access candidate records across your hiring pipeline for analysis, reporting, or integration purposes.

For detailed information about candidates and available fields, see the Workable API documentation.

[Rest API] List Stages

This endpoint template retrieves the hiring pipeline stages defined in your Workable account. Use this template when you need to reference stage names and ordering for pipeline analysis or reporting.

For detailed information about stages and available fields, see the Workable API documentation.

[Rest API] List Recruiters

This endpoint template retrieves recruiters from your Workable account. Use this template when you need to access the users responsible for recruiting activity for analysis, reporting, or integration purposes.

For detailed information about recruiters and available fields, see the Workable API documentation.

[Rest API] Get Job

This endpoint template retrieves a specific job by its shortcode. Use this template when you need detailed information about a single job posting rather than the full list.

For detailed information about retrieving a single job and available fields, see the Workable API documentation.

[Rest API] Get Candidate

This endpoint template retrieves a specific candidate by ID. Use this template when you need detailed information about a single candidate rather than the full list.

For detailed information about retrieving a single candidate and available fields, see the Workable API documentation.

[Rest API] List Members

This endpoint template retrieves the members of your Workable account. Use this template when you need to access account user records for analysis, reporting, or integration purposes.

For detailed information about members and available fields, see the Workable API documentation.

[Rest API] List Departments

This endpoint template retrieves the departments defined in your Workable account. Use this template when you need to reference department structure for organizational analysis or reporting.

For detailed information about departments and available fields, see the Workable API documentation.

[Rest API] List Requisitions

This endpoint template retrieves the requisitions in your Workable account. Use this template when you need to access headcount requests and their approval state for analysis, reporting, or integration purposes.

For detailed information about requisitions and available fields, see the Workable API documentation.

[Rest API] List Employees

This endpoint template retrieves the employees in your Workable account. Use this template when you need to access employee records for analysis, reporting, or integration purposes.

For detailed information about employees and available fields, see the Workable API documentation.

[Rest API] List Custom Attributes

This endpoint template retrieves the custom attributes defined in your Workable account. Use this template when you need to reference the custom fields configured for your recruiting data.

For detailed information about custom attributes and available fields, see the Workable API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Workable data sources can also be manually configured to ingest data from any valid Workable API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Workable data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Workable destination, and select the Send to Destination option from the menu. Select the Workable connector from the list of available destination connectors, then select the credential that will be used to connect to Workable, and click Next; or, create a new Workable credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Workable endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Create Candidate

This endpoint template creates a candidate at the specified job using records from a Nexset. Use this template when you need to add applicants to a job posting based on data from your Nexla flows.

  • Each record from your Nexset is sent as a separate request to create a candidate. The request body must contain the candidate data in the format required by the Workable API, and the target job is identified by its shortcode.

For detailed information about creating candidates and required request fields, see the Workable API documentation.

[Rest API] Create Talent Pool Candidate

This endpoint template creates a candidate in the talent pool using records from a Nexset. Use this template when you need to add prospective candidates to your talent pool rather than to a specific job.

  • Each record from your Nexset is sent as a separate request to create a talent pool candidate. The request body must contain the candidate data in the format required by the Workable API.

For detailed information about the talent pool and required request fields, see the Workable API documentation.

[Rest API] Update Candidate

This endpoint template partially updates a candidate by ID using records from a Nexset. Use this template when you need to modify existing candidate records based on data from your Nexla flows.

  • Each record from your Nexset is sent as a separate request identified by the candidate ID. Only the fields included in the request body are updated on the candidate record.

For detailed information about updating candidates and available fields, see the Workable API documentation.

[Rest API] Create Candidate Comment

This endpoint template creates a comment on a candidate's timeline using records from a Nexset. Use this template when you need to attach notes or activity to candidate records based on data from your Nexla flows.

  • Each record from your Nexset is sent as a separate request identified by the candidate ID. The request body must contain the comment content in the format required by the Workable API.

For detailed information about candidate comments and required request fields, see the Workable API documentation.

[Rest API] Move Candidate

This endpoint template moves a candidate to another stage using records from a Nexset. Use this template when you need to advance or reposition candidates in your hiring pipeline based on data from your Nexla flows.

  • Each record from your Nexset is sent as a separate request identified by the candidate ID. The request body must specify the target stage in the format required by the Workable API.

For detailed information about moving candidates between stages, see the Workable API documentation.

[Rest API] Disqualify Candidate

This endpoint template disqualifies a candidate from a job using records from a Nexset. Use this template when you need to remove candidates from active consideration based on data from your Nexla flows.

  • Each record from your Nexset is sent as a separate request identified by the candidate ID. The request body may include a disqualification reason in the format required by the Workable API.

For detailed information about disqualifying candidates, see the Workable API documentation.

Manual configuration

Workable destinations can also be manually configured to send data to any valid Workable API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Workable APIs expect JSON in the request body for write operations. For operations that act on an existing record, include the candidate ID or job shortcode in the endpoint URL as required by the Workable API.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Workable endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Workable endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.