> 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/lever.md).

# Lever

Read job postings and pipeline candidates from Lever, the recruiting ATS.

### Connectors

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

| Connector | Authentication |
| --------- | -------------- |
| Lever     | API Key        |

#### Lever

Connect to Lever with an API key to read job postings and pipeline candidates.

**Set up in Lever**

1. Prepare the Lever account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Create a key in Lever under Settings > Integrations and API > API Credentials. Super Admin required. Grant these scopes so every action and picker resolves: postings:read:admin, opportunities:read:admin, stages:read:admin, and tags:read:admin.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Lever**.
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                      | Create a key in Lever under Settings > Integrations and API > API Credentials. Super Admin required. Grant these scopes so every action and picker resolves: postings:read:admin, opportunities:read:admin, stages:read:admin, and tags:read:admin. [Provider instructions](https://hire.lever.co/settings/integrations). |
| Use Sandbox Environment | Optional / as applicable | Send requests to Lever's sandbox environment (api.sandbox.lever.co) instead of production. Sandbox access is granted only through Lever's partner program; leave this off for a regular production 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 **Lever** 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

#### List Job Postings

Browse the job postings in your Lever account.

**Required permissions:** `postings:read:admin`.

**Inputs**

| Field                | Type            | Required | Description                                                                                                     |
| -------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
| Status               | select (string) | No       | Only return postings with this status. Available values: Published, Internal, Closed, Draft, Pending, Rejected. |
| Maximum Postings     | integer         | No       | Approximate number of postings to return. Minimum: 1. Maximum: 1000. Default: 50.                               |
| Show advanced fields | boolean         | No       | Show the page cursor field. Default: false.                                                                     |
| Page Cursor          | string          | No       | Continue from a previous run. Leave empty to start from the beginning.                                          |

**Outputs**

| Field        | Type          | Description                                                     |
| ------------ | ------------- | --------------------------------------------------------------- |
| Job Postings | object\_array | The matching job postings.                                      |
| Next Cursor  | string        | Cursor for the next page, empty when there are no more results. |

#### Get Job Posting

Look up the full details of one job posting.

**Required permissions:** `postings:read:admin`.

**Inputs**

| Field       | Type            | Required | Description                                                            |
| ----------- | --------------- | -------- | ---------------------------------------------------------------------- |
| Job Posting | select (string) | Yes      | The job posting to look up. Options load from the selected connection. |

**Outputs**

| Field       | Type   | Description      |
| ----------- | ------ | ---------------- |
| Job Posting | object | The job posting. |

#### List Candidates

Browse candidates in your hiring pipeline, with filters.

**Required permissions:** `opportunities:read:admin`.

**Inputs**

| Field                       | Type            | Required | Description                                                                                                                            |
| --------------------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| Job Posting                 | select (string) | No       | Only return candidates who applied to this posting. Options load from the selected connection.                                         |
| Pipeline Stage              | select (string) | No       | Only return candidates currently in this stage. Options load from the selected connection.                                             |
| Tag                         | select (string) | No       | Only return candidates carrying this tag. Options load from the selected connection.                                                   |
| Updated Since               | datetime        | No       | Only return candidates changed after this time.                                                                                        |
| Maximum Candidates          | integer         | No       | Approximate number of candidates to return. Minimum: 1. Maximum: 1000. Default: 50.                                                    |
| Show advanced fields        | boolean         | No       | Show origin, archived, and page cursor filters. Default: false.                                                                        |
| Origin                      | select (string) | No       | Only return candidates that entered the pipeline this way. Available values: Agency, Applied, Internal, Referred, Sourced, University. |
| Include archived candidates | boolean         | No       | Include candidates who have been archived or rejected. Default: false.                                                                 |
| Page Cursor                 | string          | No       | Continue from a previous run. Leave empty to start from the beginning.                                                                 |

**Outputs**

| Field       | Type          | Description                                                     |
| ----------- | ------------- | --------------------------------------------------------------- |
| Candidates  | object\_array | The matching candidates.                                        |
| Next Cursor | string        | Cursor for the next page, empty when there are no more results. |

#### Get Candidate

Look up one candidate's full pipeline record.

**Required permissions:** `opportunities:read:admin`.

**Inputs**

| Field     | Type   | Required | Description                                                                                                                  |
| --------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| Candidate | string | Yes      | The candidate to look up. Connect this to List Candidates or Search Candidates by Email, or paste a candidate id from Lever. |

**Outputs**

| Field     | Type   | Description                      |
| --------- | ------ | -------------------------------- |
| Candidate | object | The candidate's pipeline record. |

#### Search Candidates by Email

Find a candidate in the pipeline by their email address.

**Required permissions:** `opportunities:read:admin`.

**Inputs**

| Field                       | Type    | Required | Description                                                      |
| --------------------------- | ------- | -------- | ---------------------------------------------------------------- |
| Email Address               | string  | Yes      | The candidate's email address.                                   |
| Include archived candidates | boolean | No       | Include candidates who were archived or rejected. Default: true. |

**Outputs**

| Field      | Type          | Description                                  |
| ---------- | ------------- | -------------------------------------------- |
| Candidates | object\_array | Candidates matching that email, usually one. |
| Found      | boolean       | Whether any candidate matched.               |

### Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

#### Candidate Created or Updated

Starts the workflow when a candidate is added to the pipeline or their record changes.

Optionally pick a job posting and pipeline stage to narrow what this watches. Leave both empty to fire for the whole pipeline. Turn on 'Also fire for archived candidates' to react to rejections too; leave it off to watch only the active pipeline.

**Required permissions:** `opportunities:read:admin`.

**Configuration**

| Field                             | Type            | Required | Description                                                                                                              |
| --------------------------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| Job Posting                       | select (string) | No       | Only fire for candidates on this posting. Leave empty to watch every posting. Options load from the selected connection. |
| Pipeline Stage                    | select (string) | No       | Only fire for candidates currently in this stage. Options load from the selected connection.                             |
| Also fire for archived candidates | boolean         | No       | Include candidates who were archived or rejected. Default: false.                                                        |

**Event inputs**

| Field        | Type     | Required | Description                                                                |
| ------------ | -------- | -------- | -------------------------------------------------------------------------- |
| Candidate    | object   | Yes      | The candidate that was created or changed.                                 |
| Candidate ID | string   | Yes      | Id of the candidate. Default: .                                            |
| Stage ID     | string   | No       | Id of the candidate's pipeline stage after the change.                     |
| Updated At   | datetime | Yes      | When Lever last changed the candidate. Default: 0001-01-01 00:00:00+00:00. |

**Outputs**

| Field        | Type     | Description                                            |
| ------------ | -------- | ------------------------------------------------------ |
| Candidate    | object   | The candidate that was created or changed.             |
| Candidate ID | string   | Id of the candidate.                                   |
| Stage ID     | string   | Id of the candidate's pipeline stage after the change. |
| Updated At   | datetime | When Lever last changed the candidate.                 |

### 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/lever.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.
