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

# Workable

## Overview

<CardGroup cols={3}>
  <Card title="Pre-built tooling" icon="screwdriver-wrench" href="#pre-built-tooling" />

  <Card title="Pre-built integrations" icon="square-check" href="#pre-built-integrations" />

  <Card title="Access requirements" icon="triangle-exclamation" href="#access-requirements" />

  <Card title="Setup guide" icon="rocket" href="#setup-guide" />

  <Card title="Useful links" icon="circle-info" href="#useful-links" />

  <Card title="API gotchas" icon="biohazard" href="#api-gotchas" />
</CardGroup>

## Pre-built tooling

<AccordionGroup>
  <Accordion title="✅ Authorization">
    | Tools                             | Status |
    | --------------------------------- | ------ |
    | Pre-built authorization (API Key) | ✅      |
    | Pre-built authorization UI        | ✅      |
    | Custom authorization UI           | ✅      |
    | End-user authorization guide      | ✅      |
    | Expired credentials detection     | ✅      |
  </Accordion>

  <Accordion title="✅ 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>

  <Accordion title="✅ 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>

  <Accordion title="✅ Customization">
    | Tools                              | Status                         |
    | ---------------------------------- | ------------------------------ |
    | Create or customize use-cases      | ✅                              |
    | Pre-configured pagination          | 🚫 (time to contribute: \<48h) |
    | Pre-configured rate-limit handling | ✅                              |
    | Per-customer configurations        | ✅                              |
  </Accordion>
</AccordionGroup>

### Others

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

## 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).</Tip>

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

## 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)</Note>

## 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)</Note>

<Card title="Connect to Workable" icon="link" href="/integrations/all/workable/connect" horizontal>
  Guide to connect to Workable using Nango Connect.
</Card>
