> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Workable

## Overview

> [card] [Pre-built tooling](#pre-built-tooling)

> [card] [Pre-built integrations](#pre-built-integrations)

> [card] [Access requirements](#access-requirements)

> [card] [Setup guide](#setup-guide)

> [card] [Useful links](#useful-links)

> [card] [API gotchas](#api-gotchas)

## Pre-built tooling

> [accordion] ✅ Authorization
>
> | Tools | Status |
> | - | - |
> | Pre-built authorization (API Key) | ✅ |
> | Pre-built authorization UI | ✅ |
> | Custom authorization UI | ✅ |
> | End-user authorization guide | ✅ |
> | Expired credentials detection | ✅ |

> [accordion] ✅ Read & write data
>
> | Tools | Status |
> | - | - |
> | Pre-built integrations | ✅ |
> | API unification | ✅ |
> | 2-way sync | ✅ |
> | Webhooks from Nango on data modifications | ✅ |
> | Real-time webhooks from 3rd-party API | 🚫 (time to contribute: \<48h) |
> | Proxy requests | ✅ |

> [accordion] ✅ Observability & data quality
>
> | Tools | Status |
> | - | - |
> | HTTP request logging | ✅ |
> | End-to-end type safety | ✅ |
> | Data runtime validation | ✅ |
> | OpenTelemetry export | ✅ |
> | Slack alerts on errors | ✅ |
> | Integration status API | ✅ |

> [accordion] ✅ Customization
>
> | Tools | Status |
> | - | - |
> | Create or customize use-cases | ✅ |
> | Pre-configured pagination | 🚫 (time to contribute: \<48h) |
> | Pre-configured rate-limit handling | ✅ |
> | Per-customer configurations | ✅ |

### Others

| Function name | Description | Type |
| - | - | - |
| `approve-timeoff-request` | Approve or reject a pending time-off request. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `copy-candidate` | Copy a candidate into another job, leaving the original untouched. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-candidate` | Create a candidate at a specific job. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-comment` | Create a comment on the applicant's timeline. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-department` | Create a new department | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-employee-document` | Attach a document to an employee record from a hosted URL | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-employee` | Create a new HR employee record. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-subscription` | Subscribe a target URL to a Workable event | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-talent-pool-candidate` | Create a candidate directly in the account talent pool (not tied to any job). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-time-entries-bulk` | Create up to 500 time entries across employees in one call. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-time-entry` | Record a single clock-in/clock-out or manual time entry for an employee. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-timeoff-request` | Submit a new time-off request for an employee. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `deactivate-member` | Deactivate an account member (reversible in principle via enable-member). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-department` | Permanently delete a department. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-subscription` | Unsubscribe (delete) a webhook subscription. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-time-entry` | Archive/delete a time entry. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `disqualify-candidate` | Disqualify (or mark withdrawn) a candidate. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-account` | Retrieve a single account by subdomain. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-candidate-offer` | Retrieve a candidate's latest offer, if any. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-candidate` | Retrieve full candidate details by id | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-employee-orgchart` | Retrieve the reporting-line org chart, optionally scoped to one employee. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-employee` | Retrieve full HR detail for a single employee. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-event` | Retrieve a single scheduled event by id. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-job-application-form` | Retrieve the structured application-form field definitions for a job. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-job` | Retrieve a single job by shortcode | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `invite-member` | Invite a new account member by email | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-accounts` | List accounts accessible to the current token. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-candidate-activities` | List a candidate's activity stream (comments, moves, ratings, disqualifications). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-candidate-files` | List files attached to a candidate's profile (resume, attachments). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-candidates` | List candidates with optional job/stage/email/date filters. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-collaboration-permissions` | List which account roles can perform which collaboration actions. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-custom-attributes` | List the account's custom attribute definitions. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-departments` | List the account's departments. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-disqualification-reasons` | List the account's configured disqualification reasons. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-employee-documents` | List documents attached to an employee record. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-employee-fields` | List the account's configured employee custom-field/schema definitions. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-employees` | List HR employee records. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-events` | List scheduled recruiting events (calls, interviews, meetings). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-job-activities` | List a job's activity stream (opens, applications, closures) | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-job-candidates` | List candidates for a specific job | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-job-custom-attributes` | List custom attributes configured for a specific job. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-job-members` | List account members collaborating on a specific job | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-job-questions` | List a job's application questions | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-job-recruiters` | List external recruiters collaborating on a specific job. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-job-stages` | List the pipeline stages configured for a specific job. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-jobs` | List account jobs with optional state/date filters. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-legal-entities` | List the account's legal entities/locations/sites (HR org structure). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-members` | List account members. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-permission-sets` | List the account's available custom permission sets/roles. Use the `name` field (not id/label) when assigning custom roles via update-member/invite-member. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-recruiters` | List external recruiters on the account. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-requisitions` | List headcount requisitions (Hiring Plan feature). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-stages` | List the account's recruitment pipeline stages. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-subscriptions` | List active webhook subscriptions. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-time-entries` | List time-tracking entries with employee/date/duration filters. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-timeoff-balances` | Get an employee's current time-off balances by category. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-timeoff-categories` | List the account's time-off categories (PTO, sick leave, etc). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-timeoff-requests` | List time-off requests with date, state, and employee filters. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-work-schedules` | List the account's configured work schedules. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `move-candidate` | Move a candidate to a different pipeline stage. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `rate-candidate` | Add a new rating/evaluation for a candidate at their current stage. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `relocate-candidate` | Move a candidate to another job, deleting the original candidate record. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `revert-candidate-disqualification` | Undo a candidate disqualification, restoring them to their prior stage. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-candidate-custom-attribute` | Set a custom attribute value on a candidate | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-candidate-rating` | Create or update the acting member's evaluation for a candidate's current (or specified) stage. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-candidate-tags` | Replace a candidate's tag list. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-candidate` | Update candidate fields | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-employee` | Update an existing employee. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-member` | Update an existing member's roles/collaboration rules. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-time-entry` | Update an existing time entry's times or note. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `candidates-activities` | Sync activity streams (comments, moves, ratings, disqualifications) for each candidate | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `candidates-offer` | Sync each candidate's latest offer, where one exists. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `candidates` | Sync candidates across all jobs and the talent pool | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `custom-attributes` | Sync account-level custom attribute definitions | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `departments` | Sync account departments. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `disqualification-reasons` | Sync the account's configured disqualification reasons. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `employees` | Sync HR employee records. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `events` | Sync scheduled recruiting events (calls, interviews, meetings). | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `jobs-candidates` | Sync candidates scoped to each job. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `jobs-questions` | Sync application questions for each job. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `jobs-stages` | Sync the pipeline stages configured for each job. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `jobs` | Sync account jobs | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `legal-entities` | Sync HR legal entities/locations/sites org structure | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `members` | Sync account members. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `permission-sets` | Sync the account's custom permission sets/roles. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `recruiters` | Sync external recruiters on the account. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `requisitions` | Sync headcount requisitions (Hiring Plan feature) | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `stages` | Sync account-level recruitment pipeline stages. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `subscriptions` | Sync the account's registered webhook subscriptions | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `time-entries` | Sync time-tracking clock-in/clock-out entries. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `timeoff-balances` | Sync current-cycle time-off balances per employee. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `timeoff-categories` | Sync the account's time-off categories. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `timeoff-requests` | Sync employee time-off requests and their approval state. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `work-schedules` | Sync the account's configured work schedules. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

## Access requirements

| Pre-Requisites | Status | Comment |
| - | - | - |
| Paid dev account | ❓ | |
| Paid test account | ❓ | |
| Partnership | ❓ | |
| App review | ❓ | |
| Security audit | ❓ | |

## Setup guide

*No setup guide yet.*

> [!TIP]
>
> Need help getting started? Get help in the [community](https://nango.dev/slack).

> [!NOTE]
>
> Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/workable.mdx)

## Useful links

Workable offers API keys ("API access token"), partner tokens, and OAuth for authentication. Nango currently only supports API-key-based authentication.

* [API Docs](https://workable.readme.io/reference)
* [How to generate an API key](https://workable.readme.io/reference/generate-an-access-token#generate-an-api-access-token)
* [OAuth related docs](https://workable.readme.io/page/oauth)
* [Workable API rate limits](https://workable.readme.io/reference/rate-limits)
* [Web API docs (their REST API)](https://workable.readme.io/reference/accounts)

> [!NOTE]
>
> Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/workable.mdx)

## Connection configuration in Nango

* Workable requires a user specific subdomain for the API base URL.

## API gotchas

* To authorize a Workable Connection in Nango you need to pass both the API key and the company's workable subdomain.
* The API base URL in Nango is set to `https://{subdomain}.workable.com` for future forward compatability. To call endpoints of the V3 API, prefix the endpoint with `/spi/v3/`, e.g. `/spi/v3/candidates`.

> [!NOTE]
>
> Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/workable.mdx)

> [card] [Connect to Workable](https://nango.dev/docs/integrations/all/workable/connect)
>
> Guide to connect to Workable using Nango Connect.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.