> For the complete documentation index, see [llms.txt](https://docs.slingdata.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.slingdata.io/connections/api-connections/workable.md).

# Workable

Connect & Ingest data from Workable

Workable is a leading applicant tracking system (ATS) and recruiting platform that helps businesses manage the entire hiring process. The Sling Workable connector extracts data from the Workable REST API v3, supporting jobs, candidates, activities, events, members, stages, and other recruitment data.

{% hint style="success" %}
**CLI Pro Required**: APIs require a [CLI Pro token](/sling-cli/cli-pro.md) or [Platform Plan](/sling-platform/platform.md).
{% endhint %}

## Setup

The following credentials and inputs are accepted:

**Secrets:**

* `api_token` **(required)** -> Your Workable API Access Token

**Inputs:**

* `subdomain` **(required)** -> Your Workable subdomain (e.g., `mycompany` from `mycompany.workable.com`)
* `anchor_date` (optional) -> The starting date for the first incremental run (default: `2000-01-01`, all history). Format: `YYYY-MM-DD`

### Getting Your API Token

1. Log in to your [Workable account](https://www.workable.com/)
2. Click your profile icon in the top-right corner
3. Go to **Settings** > **Integrations** > **Apps** > **Generate API token**
4. Select the required scopes for your use case:
   * `r_account` - Account data (members, departments, stages)
   * `r_jobs` - Jobs and job sub-resources
   * `r_candidates` - Candidates and candidate sub-resources
   * `r_requisitions` - Requisitions
5. Click **Generate** and copy your token

{% hint style="warning" %}
**Important:** Workable API tokens are tied to specific scopes. Ensure your token has all required scopes for the endpoints you plan to use.
{% endhint %}

### Using `sling conns`

{% code overflow="wrap" %}

```bash
sling conns set WORKABLE type=api spec=workable secrets='{ api_token: "${WORKABLE_API_TOKEN}" }' inputs='{ subdomain: mycompany }'
```

{% endcode %}

### Environment Variable

See [here](https://docs.slingdata.io/connections/api-connections/pages/eAdVs2BHCgdr6RS8GoJC#dot-env-file-.env.sling) to learn more about the `.env.sling` file.

{% code overflow="wrap" %}

```bash
export WORKABLE='{ type: api, spec: workable, secrets: { api_token: "your_api_token" }, inputs: { subdomain: "mycompany" } }'
```

{% endcode %}

### Sling Env File YAML

See [here](https://docs.slingdata.io/connections/api-connections/pages/eAdVs2BHCgdr6RS8GoJC#sling-env-file-env.yaml) to learn more about the sling `env.yaml` file.

```yaml
connections:
  WORKABLE:
    type: api
    spec: workable
    secrets:
      api_token: ${WORKABLE_API_TOKEN}
    inputs:
      subdomain: "mycompany"
```

**With anchor date for historical data:**

```yaml
connections:
  WORKABLE:
    type: api
    spec: workable
    secrets:
      api_token: ${WORKABLE_API_TOKEN}
    inputs:
      subdomain: "mycompany"
      anchor_date: "2023-01-01"
```

## Replication

Here's an example replication configuration to sync Workable data to a PostgreSQL database:

```yaml
source: WORKABLE
target: MY_POSTGRES

defaults:
  mode: incremental
  object: workable.{stream_name}

streams:
  # Core incremental endpoints
  jobs:
  candidates:
  events:
  requisitions:

  # Reference data (full-refresh)
  members:
    mode: full-refresh
  stages:
    mode: full-refresh
  departments:
    mode: full-refresh
```

**Sync all endpoints:**

```yaml
source: WORKABLE
target: MY_POSTGRES

defaults:
  mode: full-refresh
  object: workable.{stream_name}

streams:
  '*':
```

## Endpoints

### Account & Reference Data

| Endpoint                   | Description                        | Incremental |
| -------------------------- | ---------------------------------- | ----------- |
| `members`                  | Account team members               | No          |
| `recruiters`               | External recruiters                | No          |
| `stages`                   | Global recruitment pipeline stages | No          |
| `departments`              | Account departments                | No          |
| `disqualification_reasons` | Candidate disqualification reasons | No          |
| `custom_attributes`        | Account-level custom attributes    | No          |

### Jobs

| Endpoint | Description  | Incremental              |
| -------- | ------------ | ------------------------ |
| `jobs`   | Job postings | Yes (by `created_after`) |

### Job Sub-Resources (Per-Job)

These endpoints iterate over jobs extracted by the `jobs` endpoint:

| Endpoint                | Description                          | Incremental |
| ----------------------- | ------------------------------------ | ----------- |
| `job_stages`            | Pipeline stages per job              | No          |
| `job_members`           | Team members assigned per job        | No          |
| `job_recruiters`        | External recruiters assigned per job | No          |
| `job_activities`        | Activity stream per job              | No          |
| `job_questions`         | Screening questions per job          | No          |
| `job_custom_attributes` | Custom attributes per job            | No          |

### Candidates

| Endpoint     | Description    | Incremental              |
| ------------ | -------------- | ------------------------ |
| `candidates` | Candidate list | Yes (by `created_after`) |

### Candidate Sub-Resources (Per-Candidate)

These endpoints iterate over candidates extracted by the `candidates` endpoint:

| Endpoint               | Description                                            | Incremental |
| ---------------------- | ------------------------------------------------------ | ----------- |
| `candidate_details`    | Full candidate profile (education, experience, social) | No          |
| `candidate_activities` | Activity stream per candidate                          | No          |
| `candidate_offer`      | Offer details per candidate (skips if no offer)        | No          |

### Events & Requisitions

| Endpoint       | Description                  | Incremental              |
| -------------- | ---------------------------- | ------------------------ |
| `events`       | Interview and meeting events | Yes (by `since_id`)      |
| `requisitions` | Hiring requisitions          | Yes (by `created_after`) |

To discover available endpoints:

```bash
sling conns discover WORKABLE
```

## Incremental Sync

The Workable connector uses `created_after` time-based incremental sync for supported endpoints:

* **First run:** Fetches records created from `anchor_date` (default: `2000-01-01`) to present
* **Subsequent runs:** Only fetches records created after the last sync

Incremental sync is supported for:

* `jobs`
* `candidates`
* `requisitions`
* `events` (by `since_id`)

## Parent-Child Endpoints

The Workable connector uses a queue-based pattern for sub-resource endpoints:

1. The parent endpoint runs first (e.g., `jobs`)
2. Record identifiers are collected into a queue (e.g., job shortcodes)
3. Child endpoints iterate through the queue to fetch per-record data

This means:

* `jobs` must run before any `job_*` endpoint
* `candidates` must run before any `candidate_*` endpoint

When using `'*'` to sync all endpoints, this ordering is handled automatically.

## Rate Limiting

The Workable API has strict rate limits:

* **Account API tokens:** 10 requests per 10 seconds

The connector automatically:

* Uses conservative rate limiting (0.4 requests/second) to stay under the limit
* Retries with exponential backoff on 429 (rate limit) responses

## Common Use Cases

### Sync Core Recruiting Data

```yaml
source: WORKABLE
target: MY_POSTGRES

defaults:
  mode: incremental
  object: recruiting.{stream_name}

streams:
  jobs:
  candidates:
  candidate_details:
  events:
```

### Sync Job Pipeline Data

```yaml
source: WORKABLE
target: MY_POSTGRES

defaults:
  mode: full-refresh
  object: pipeline.{stream_name}

streams:
  jobs:
  job_stages:
  job_members:
  job_activities:
  job_questions:
```

### Sync Reference Data

```yaml
source: WORKABLE
target: MY_POSTGRES

defaults:
  mode: full-refresh
  object: reference.{stream_name}

streams:
  members:
  stages:
  departments:
  disqualification_reasons:
  custom_attributes:
```

If you are facing issues connecting, please reach out to us at <support@slingdata.io>, on [discord](https://discord.gg/q5xtaSNDvp) or open a Github Issue [here](https://github.com/slingdata-io/sling-cli/issues).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.slingdata.io/connections/api-connections/workable.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
