> ## 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

<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>

### Candidates

| Function name | Description                                | Type                                           | Source code                                                                                                       |
| ------------- | ------------------------------------------ | ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `candidates`  | Fetches a list of candidates from workable | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/workable/syncs/candidates.ts) |

### Others

| Function name           | Description                                                      | Type                                           | Source code                                                                                                                  |
| ----------------------- | ---------------------------------------------------------------- | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `candidates-activities` | Fetches a list of activity streams of the given candidate        | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/workable/syncs/candidates-activities.ts) |
| `candidates-offer`      | Fetches candidate's latest offer from workable                   | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/workable/syncs/candidates-offer.ts)      |
| `jobs`                  | Fetches a list of jobs from workable                             | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/workable/syncs/jobs.ts)                  |
| `jobs-candidates`       | Fetches a list of candidates for the specified job from workable | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/workable/syncs/jobs-candidates.ts)       |
| `jobs-questions`        | Fetches a list of questions for the specified job from workable  | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/workable/syncs/jobs-questions.ts)        |
| `members`               | Fetches a list of account members from workable                  | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/workable/syncs/members.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>