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

# Workable

API configuration: [`workable`](https://nango.dev/providers.yaml)

## Features

| Features                                                             | Status                         |
| -------------------------------------------------------------------- | ------------------------------ |
| [Auth (API Key)](/integrate/guides/authorize-an-api)                 | ✅                              |
| [Sync data](/integrate/guides/sync-data-from-an-api)                 | ✅                              |
| [Perform workflows](/integrate/guides/perform-workflows-with-an-api) | ✅                              |
| [Proxy requests](/integrate/guides/proxy-requests-to-an-api)         | ✅                              |
| [Receive webhooks](/integrate/guides/receive-webhooks-from-an-api)   | 🚫 (time to contribute: \<48h) |

<Tip>We can implement missing features in \<48h, just ask for it in the [community](https://nango.dev/slack).</Tip>

## Getting started

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)
* [Workable API rate limits](https://workable.readme.io/reference/rate-limits)
* [Web API docs (their REST API)](https://workable.readme.io/reference/accounts)

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

## Connection configuration in Nango

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

You should request this from the user and pass it to Nango in the `nango.auth()` call:

```js
nango.auth('workable', '<CONNECTION-ID>', {params: {subdomain: '<workable-subdomain>'}});
```

For more details see the [docs here](/integrate/guides/authorize-an-api#apis-requiring-connection-specific-configuration-for-authorization).

## API gotchas

* To authorize a Workable Connection in Nango you need to pass both the API key and the company's workable subdomain:

```js
nango.auth('workable', '<CONNECTION-ID>', {
        credentials: {
            apiKey: '<END-USER-API-KEY>'
        },
        params: {
            subdomain: '<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>Add Getting Started links and Gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/gong.mdx)</Note>