> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Lever

> How to set up the Lever connector, plus the actions and events that are available.

![Lever](https://stackone-logos.com/api/lever/filled/svg)

v3.0.1[See changelog](https://docs.stackone.com/connectors/lever/changelog.md)

[77 actions](#actions) · [10 events](#events) · 2 auth methods

ATS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/lever/guides/connector-profile/oauth-2-0.md)
>
> Requires registering an app through Lever's Partner Program and receiving OAuth credentials from the Lever team. Access...

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/lever/guides/connector-profile/api-key.md)
>
> Uses a Lever API key for internal workflows — no partner registration needed. A Super Admin generates the key and picks,...

Optionally, configure receiving Events for Lever into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/lever/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/lever/guides/link-account/oauth-2-0.md)

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/lever/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

applications:read:admin

archive\_reasons:read:admin

contact:read:admin

contact:write:admin

eeo\_responses:read:admin

eeo\_responses\_pii:read:admin

feedback:read:admin

feedback:write:admin

feedback\_templates:read:admin

files:read:admin

files:write:admin

forms:read:admin

interviews:read:admin

interviews:write:admin

notes:read:admin

notes:write:admin

offers:read:admin

opportunities:read:admin

opportunities:write:admin

panels:read:admin

postings:read:admin

postings:write:admin

referrals:read:admin

requisition\_fields:read:admin

requisition\_fields:write:admin

requisitions:read:admin

requisitions:write:admin

resumes:read:admin

sources:read:admin

stages:read:admin

tags:read:admin

uploads:write:admin

users:read:admin

users:write:admin

No scopes found

77 actions

ActionDescriptionRequired scopes

List Archive Reasons`lever_list_archive_reasons`

Retrieve all archive reasons configured in the account

`archive_reasons:read:admin`

Get Archive Reason`lever_get_archive_reason`

Retrieve a specific archive reason by its unique identifier

`archive_reasons:read:admin`

Get Contact`lever_get_contact`

Retrieve a specific contact by its unique identifier

`contact:read:admin`

Update Contact`lever_update_contact`

Update the properties of an existing contact

`contact:write:admin`

List EEO Responses With PII`lever_list_eeo_responses_pii`

Retrieve EEO responses including personally identifiable information

`eeo_responses_pii:read:admin`

List Anonymous EEO Responses`lever_list_eeo_responses_anonymous`

Retrieve anonymized EEO responses without personally identifiable information

`eeo_responses:read:admin`

List Opportunity Feedback`lever_list_opportunity_feedback`

Retrieve all feedback forms submitted for a specific opportunity

`feedback:read:admin`

Get Opportunity Feedback`lever_get_opportunity_feedback`

Retrieve a specific feedback form for an opportunity

`feedback:read:admin`

Delete Opportunity Feedback`lever_delete_opportunity_feedback`

Delete a feedback form from an opportunity

`feedback:write:admin`

List Feedback Templates`lever_list_feedback_templates`

Retrieve all active feedback templates in the account

`feedback_templates:read:admin`

Get Feedback Template`lever_get_feedback_template`

Retrieve a specific feedback template by its unique identifier

`feedback_templates:read:admin`

Upload Opportunity File`lever_upload_opportunity_file`

Upload a file to a candidate's opportunity. The file must be provided as base64 encoded content — do not pass a file pat...

`files:write:admin`

Get Opportunity File`lever_get_opportunity_file`

Retrieve metadata for a single file attached to an opportunity

`files:read:admin`

List Opportunity Files`lever_list_opportunity_files`

List all files attached to an opportunity

`files:read:admin`

Download Opportunity File`lever_download_opportunity_file`

Download the actual file content from an opportunity

`files:read:admin`

Delete Opportunity File`lever_delete_opportunity_file`

Delete a file from an opportunity

`files:write:admin`

Upload File`lever_upload_file`

Upload a temporary file for use with posting applications. The file must be provided as base64 encoded content — do not...

`uploads:write:admin`

Get Opportunity Interview`lever_get_opportunity_interview`

Retrieve a single interview for an opportunity

`interviews:read:admin`

List Opportunity Interviews`lever_list_opportunity_interviews`

List all interviews for an opportunity

`interviews:read:admin`

Create Opportunity Interview`lever_create_opportunity_interview`

Create a new interview for an opportunity

`interviews:write:admin`

Update Opportunity Interview`lever_update_opportunity_interview`

Update an existing interview

`interviews:write:admin`

Delete Opportunity Interview`lever_delete_opportunity_interview`

Delete an interview from an opportunity

`interviews:write:admin`

Get Opportunity Note`lever_get_opportunity_note`

Retrieve a single note from an opportunity

`notes:read:admin`

List Opportunity Notes`lever_list_opportunity_notes`

List all notes for an opportunity

`notes:read:admin`

Create Opportunity Note`lever_create_opportunity_note`

Create a new note for an opportunity

`notes:write:admin`

Delete Opportunity Note`lever_delete_opportunity_note`

Delete a note from an opportunity

`notes:write:admin`

List Opportunities`lever_list_opportunities`

Retrieve all opportunities in the pipeline

`opportunities:read:admin`

Get Opportunity`lever_get_opportunity`

Retrieve a single opportunity by ID

`opportunities:read:admin`

List Deleted Opportunities`lever_list_deleted_opportunities`

Retrieve all deleted opportunities

`opportunities:read:admin`

Update Opportunity Stage`lever_update_opportunity_stage`

Change the pipeline stage for an opportunity

`opportunities:write:admin`

Archive/Unarchive Opportunity`lever_update_opportunity_archived`

Update the archived state of an opportunity

`opportunities:write:admin`

Add Tags To Opportunity`lever_add_opportunity_tags`

Add tags to an opportunity

`opportunities:write:admin`

Remove Tags From Opportunity`lever_remove_opportunity_tags`

Remove tags from an opportunity

`opportunities:write:admin`

Add Sources To Opportunity`lever_add_opportunity_sources`

Add sources to an opportunity

`opportunities:write:admin`

Remove Sources From Opportunity`lever_remove_opportunity_sources`

Remove sources from an opportunity

`opportunities:write:admin`

Add Links To Opportunity`lever_add_opportunity_links`

Add links to an opportunity contact

`opportunities:write:admin`

Remove Links From Opportunity`lever_remove_opportunity_links`

Remove links from an opportunity contact

`opportunities:write:admin`

List Opportunity Applications`lever_list_opportunity_applications`

List all applications for an opportunity

`applications:read:admin`

Get Opportunity Application`lever_get_opportunity_application`

Retrieve a single application for an opportunity

`applications:read:admin`

List Opportunity Resumes`lever_list_opportunity_resumes`

List all resumes for an opportunity

`resumes:read:admin`

Get Opportunity Resume`lever_get_opportunity_resume`

Retrieve metadata for a single resume

`resumes:read:admin`

Download Opportunity Resume`lever_download_opportunity_resume`

Download a resume from an opportunity

`resumes:read:admin`

List Opportunity Panels`lever_list_opportunity_panels`

List all interview panels for an opportunity

`panels:read:admin`

Get Opportunity Panel`lever_get_opportunity_panel`

Retrieve a single interview panel for an opportunity

`panels:read:admin`

List Opportunity Offers`lever_list_opportunity_offers`

List all offers for an opportunity

`offers:read:admin`

Download Opportunity Offer`lever_download_opportunity_offer`

Download an offer document

`offers:read:admin`

List Opportunity Referrals`lever_list_opportunity_referrals`

List all referrals for an opportunity

`referrals:read:admin`

Get Opportunity Referral`lever_get_opportunity_referral`

Retrieve a single referral for an opportunity

`referrals:read:admin`

List Opportunity Forms`lever_list_opportunity_forms`

List all profile forms for an opportunity

`forms:read:admin`

Get Opportunity Form`lever_get_opportunity_form`

Retrieve a single profile form for an opportunity

`forms:read:admin`

List Postings`lever_list_postings`

Retrieve all job postings

`postings:read:admin`

Get Posting`lever_get_posting`

Retrieve a single job posting by ID

`postings:read:admin`

Create Posting`lever_create_posting`

Create a new job posting

`postings:write:admin`

Update Posting`lever_update_posting`

Update an existing job posting

`postings:write:admin`

Get Posting Apply Questions`lever_get_posting_apply_questions`

Get application form questions for a posting

`postings:read:admin`

Apply To Posting`lever_apply_to_posting`

Submit an application to a posting

`postings:write:admin`

List Requisitions`lever_list_requisitions`

Retrieve all requisitions

`requisitions:read:admin`

Get Requisition`lever_get_requisition`

Retrieve a single requisition by ID

`requisitions:read:admin`

Create Requisition`lever_create_requisition`

Create a new requisition

`requisitions:write:admin`

Update Requisition`lever_update_requisition`

Update an existing requisition

`requisitions:write:admin`

List Requisition Fields`lever_list_requisition_fields`

Retrieve all requisition custom fields

`requisition_fields:read:admin`

Get Requisition Field`lever_get_requisition_field`

Retrieve a single requisition field

`requisition_fields:read:admin`

Create Requisition Field`lever_create_requisition_field`

Create a custom requisition field

`requisition_fields:write:admin`

Update Requisition Field`lever_update_requisition_field`

Update a custom requisition field

`requisition_fields:write:admin`

Add Requisition Field Options`lever_add_requisition_field_options`

Add options to a dropdown requisition field

`requisition_fields:write:admin`

Update Requisition Field Options`lever_update_requisition_field_options`

Update existing options on a dropdown requisition field

`requisition_fields:write:admin`

Delete Requisition Field Options`lever_delete_requisition_field_options`

Delete options from a dropdown requisition field

`requisition_fields:write:admin`

List Sources`lever_list_sources`

Retrieve all candidate sources

`sources:read:admin`

List Stages`lever_list_stages`

Retrieve all pipeline stages

`stages:read:admin`

Get Stage`lever_get_stage`

Retrieve a single pipeline stage by ID

`stages:read:admin`

List Tags`lever_list_tags`

Retrieve all tags

`tags:read:admin`

List Users`lever_list_users`

Retrieve all users in the account

`users:read:admin`

Get User`lever_get_user`

Retrieve a single user by ID

`users:read:admin`

Create User`lever_create_user`

Create a new user with Interviewer role

`users:write:admin`

Update User`lever_update_user`

Update an existing user

`users:write:admin`

Deactivate User`lever_deactivate_user`

Deactivate a user account

`users:write:admin`

Reactivate User`lever_reactivate_user`

Reactivate a deactivated user account

`users:write:admin`

## Events

Tags

Select all
|
Clear

Applications

Contacts

Interviews

Opportunities

Webhooks

No tags found

10 events

EventDescriptionTags

Application Created`lever_webhook_application_create`

Processes events fired when a candidate application is created in Lever.

ApplicationsWebhooks

Candidate Hired`lever_webhook_candidate_hired`

Processes events fired when a candidate is marked as hired in Lever.

OpportunitiesWebhooks

Candidate Stage Changed`lever_webhook_candidate_stage_change`

Processes events fired when a candidate moves from one stage to another, including the stage moved from and to.

OpportunitiesWebhooks

Candidate Archive State Changed`lever_webhook_candidate_archive_changed`

Processes events fired when a candidate is archived or unarchived, including the previous and updated archive state.

OpportunitiesWebhooks

Candidate Deleted`lever_webhook_candidate_deleted`

Processes events fired when a candidate is deleted, including the user who deleted them.

OpportunitiesWebhooks

Interview Created`lever_webhook_interview_created`

Processes events fired when an interview is created in Lever.

InterviewsWebhooks

Interview Updated`lever_webhook_interview_updated`

Processes events fired when an interview is updated in Lever.

InterviewsWebhooks

Interview Deleted`lever_webhook_interview_deleted`

Processes events fired when an interview is deleted in Lever.

InterviewsWebhooks

Contact Created`lever_webhook_contact_created`

Processes events fired when a contact is created in Lever.

ContactsWebhooks

Contact Updated`lever_webhook_contact_update`

Processes events fired when a contact is updated in Lever.

ContactsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.