> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/ashby.md).

# Ashby

Integration with Ashby ATS for managing candidates, jobs, and applications.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Ashby     | API Key        |

#### Ashby

Connect to Ashby ATS to manage candidates, jobs, and applications.

**Set up in Ashby**

1. Sign in to Ashby as an Admin.
2. Open **Admin → Integrations → API keys** and click **+ New** to launch the API key setup wizard.
3. Name the key, choose the integration partner if prompted, and grant the read permissions for the modules you need (jobs, postings, openings).
4. Copy the generated API key.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Ashby**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                           |
| ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes      | Your Ashby API key. You can create one in your Ashby account settings. [Provider instructions](https://app.ashbyhq.com/admin/api/keys). |

**Provider documentation:** [Setup reference](https://docs.ashbyhq.com/how-do-i-generate-an-api-key).

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Ashby** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Get Job Info

Get detailed information about a specific job

**Inputs**

| Field  | Type   | Required | Description                       |
| ------ | ------ | -------- | --------------------------------- |
| Job ID | string | Yes      | The unique identifier of the job. |

**Outputs**

| Field           | Type   | Description                                           |
| --------------- | ------ | ----------------------------------------------------- |
| Job Information | object | Complete job information from the Ashby API response. |

#### List Jobs

List jobs from Ashby ATS with optional search and pagination

**Inputs**

| Field      | Type   | Required | Description                                                            |
| ---------- | ------ | -------- | ---------------------------------------------------------------------- |
| Limit      | number | No       | Maximum number of jobs to return (default: 50, max: 100). Default: 50. |
| Offset     | number | No       | Number of jobs to skip for pagination (default: 0). Default: 0.        |
| Search     | string | No       | Search term to filter jobs by title or description (optional).         |
| Department | string | No       | Filter jobs by department (optional).                                  |
| Location   | string | No       | Filter jobs by location (optional).                                    |

**Outputs**

| Field       | Type          | Description                                                    |
| ----------- | ------------- | -------------------------------------------------------------- |
| Jobs        | object\_array | Complete list of jobs from the Ashby API response.             |
| Total Count | number        | Total number of jobs matching the search criteria.             |
| Has More    | boolean       | Whether there are more jobs available beyond the current page. |

#### Search Jobs

Search for jobs using a query string with optional filters

**Inputs**

| Field        | Type   | Required | Description                                                            |
| ------------ | ------ | -------- | ---------------------------------------------------------------------- |
| Search Query | string | Yes      | Search query to find jobs by title, description, or other fields.      |
| Limit        | number | No       | Maximum number of jobs to return (default: 50, max: 100). Default: 50. |
| Offset       | number | No       | Number of jobs to skip (default: 0). Default: 0.                       |
| Department   | string | No       | Filter jobs by department.                                             |
| Location     | string | No       | Filter jobs by location.                                               |

**Outputs**

| Field       | Type          | Description                                                    |
| ----------- | ------------- | -------------------------------------------------------------- |
| Jobs        | object\_array | Complete list of jobs from the Ashby API response.             |
| Total Count | number        | Total number of jobs matching the search criteria.             |
| Has More    | boolean       | Whether there are more jobs available beyond the current page. |

#### List Job Boards

List all job boards in the Ashby system

**Inputs**

| Field  | Type   | Required | Description                                                                  |
| ------ | ------ | -------- | ---------------------------------------------------------------------------- |
| Limit  | number | No       | Maximum number of job boards to return (default: 50, max: 100). Default: 50. |
| Offset | number | No       | Number of job boards to skip (default: 0). Default: 0.                       |

**Outputs**

| Field       | Type          | Description                                                          |
| ----------- | ------------- | -------------------------------------------------------------------- |
| Job Boards  | object\_array | Complete list of job boards from the Ashby API response.             |
| Total Count | number        | Total number of job boards.                                          |
| Has More    | boolean       | Whether there are more job boards available beyond the current page. |

#### Get Job Interview Plan

Get detailed interview plan information for a specific job

**Inputs**

| Field  | Type   | Required | Description                       |
| ------ | ------ | -------- | --------------------------------- |
| Job ID | string | Yes      | The unique identifier of the job. |

**Outputs**

| Field          | Type   | Description                                                          |
| -------------- | ------ | -------------------------------------------------------------------- |
| Interview Plan | object | Complete job interview plan information from the Ashby API response. |

#### Get Job Posting

Get detailed information about a specific job posting

**Inputs**

| Field          | Type   | Required | Description                               |
| -------------- | ------ | -------- | ----------------------------------------- |
| Job Posting ID | string | Yes      | The unique identifier of the job posting. |

**Outputs**

| Field       | Type   | Description                                                   |
| ----------- | ------ | ------------------------------------------------------------- |
| Job Posting | object | Complete job posting information from the Ashby API response. |

#### List Job Postings

List all job postings with optional filtering

**Inputs**

| Field  | Type   | Required | Description                                                                    |
| ------ | ------ | -------- | ------------------------------------------------------------------------------ |
| Limit  | number | No       | Maximum number of job postings to return (default: 50, max: 100). Default: 50. |
| Offset | number | No       | Number of job postings to skip (default: 0). Default: 0.                       |
| Job ID | string | No       | Filter job postings by job ID.                                                 |
| Status | string | No       | Filter job postings by status.                                                 |

**Outputs**

| Field        | Type          | Description                                                            |
| ------------ | ------------- | ---------------------------------------------------------------------- |
| Job Postings | object\_array | Complete list of job postings from the Ashby API response.             |
| Total Count  | number        | Total number of job postings.                                          |
| Has More     | boolean       | Whether there are more job postings available beyond the current page. |

#### List Job Templates

List all job templates with optional filtering

**Inputs**

| Field      | Type   | Required | Description                                                                     |
| ---------- | ------ | -------- | ------------------------------------------------------------------------------- |
| Limit      | number | No       | Maximum number of job templates to return (default: 50, max: 100). Default: 50. |
| Offset     | number | No       | Number of job templates to skip (default: 0). Default: 0.                       |
| Department | string | No       | Filter job templates by department.                                             |

**Outputs**

| Field         | Type          | Description                                                             |
| ------------- | ------------- | ----------------------------------------------------------------------- |
| Job Templates | object\_array | Complete list of job templates from the Ashby API response.             |
| Total Count   | number        | Total number of job templates.                                          |
| Has More      | boolean       | Whether there are more job templates available beyond the current page. |

#### Get Opening

Get detailed information about a specific opening

**Inputs**

| Field      | Type   | Required | Description                           |
| ---------- | ------ | -------- | ------------------------------------- |
| Opening ID | string | Yes      | The unique identifier of the opening. |

**Outputs**

| Field   | Type   | Description                                               |
| ------- | ------ | --------------------------------------------------------- |
| Opening | object | Complete opening information from the Ashby API response. |

#### List Openings

List all openings with optional filtering

**Inputs**

| Field      | Type   | Required | Description                                                                |
| ---------- | ------ | -------- | -------------------------------------------------------------------------- |
| Limit      | number | No       | Maximum number of openings to return (default: 50, max: 100). Default: 50. |
| Offset     | number | No       | Number of openings to skip (default: 0). Default: 0.                       |
| Job ID     | string | No       | Filter openings by job ID.                                                 |
| Status     | string | No       | Filter openings by status.                                                 |
| Department | string | No       | Filter openings by department.                                             |

**Outputs**

| Field       | Type          | Description                                                        |
| ----------- | ------------- | ------------------------------------------------------------------ |
| Openings    | object\_array | Complete list of openings from the Ashby API response.             |
| Total Count | number        | Total number of openings.                                          |
| Has More    | boolean       | Whether there are more openings available beyond the current page. |

#### Search Openings

Search for openings by identifier or UUID with optional filters

**Inputs**

| Field              | Type   | Required | Description                                                                                 |
| ------------------ | ------ | -------- | ------------------------------------------------------------------------------------------- |
| Opening Identifier | string | Yes      | The identifier of the opening you want to search for (e.g., '1', '2', '3' or opening UUID). |
| Limit              | number | No       | Maximum number of openings to return (default: 50, max: 100). Default: 50.                  |
| Offset             | number | No       | Number of openings to skip (default: 0). Default: 0.                                        |
| Department         | string | No       | Filter openings by department.                                                              |
| Location           | string | No       | Filter openings by location.                                                                |
| Status             | string | No       | Filter openings by status.                                                                  |

**Outputs**

| Field       | Type          | Description                                                        |
| ----------- | ------------- | ------------------------------------------------------------------ |
| Openings    | object\_array | Complete list of openings from the Ashby API response.             |
| Total Count | number        | Total number of openings matching the search criteria.             |
| Has More    | boolean       | Whether there are more openings available beyond the current page. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# 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.stackai.com/integrations/catalog/ashby.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.
