The Lever connector lets your AI agent act in each user's Lever account. Each user signs in to Lever once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 77 tools.
- Tools
- 77
- What they doRead · write · destructive
- 46 · 25 · 646 read25 write6 destructive
- Users sign in with
- OAuth
- OAuth app
- Your own Lever app
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Lever connection
In AgentKit > Connections, create a Lever connection and copy its redirect URI. The name you give it is the
connection_nameyour code passes. See Configure connections.Register an OAuth app
Lever connections use your own OAuth app. Register one with Lever and add the redirect URI you copied.
Then enter the app's Client ID and Client Secret on the Lever connection.
Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'lever'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Lever:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'lever_archive_reasons_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "lever"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Lever:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="lever_archive_reasons_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user signs in once. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toollever_applications_deleted_listList applications deleted from the Lever account within a time window of at most 30 days.Read-onlyList Deleted Applications
List applications deleted from the Lever account within a time window of at most 30 days. Returns a page of deleted applications with id, deletedAt, opportunityId and postingId. Use this to sync application deletions. Use lever_opportunity_get with expand applications for live applications.
Inputs
deleted_at_endintegerrequired- End of the deletion window (exclusive). The window may not exceed 30 days. Unix timestamp in milliseconds. Example: 1407460069499
deleted_at_startintegerrequired- Start of the deletion window (inclusive). The window may not exceed 30 days. Unix timestamp in milliseconds. Example: 1407460069499
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
lever_archive_reason_getRetrieve one archive reason.Read-onlyGet Archive Reason
Retrieve one archive reason. Returns the reason id, text, status and type. Use this to resolve an archive reason UID. Use lever_archive_reasons_list for every reason.
Inputs
archive_reason_idstringrequired- Archive reason UID. Get it from lever_archive_reasons_list. Example: 63dd55b2-a99f-4e7b-985f-22c7bf80ab42
lever_archive_reasons_listList the archive reasons in the Lever account, optionally only hired or non-hired ones.Read-onlyList Archive Reasons
List the archive reasons in the Lever account, optionally only hired or non-hired ones. Returns archive reasons with id, text, status and type. Use this to get a reason UID for lever_opportunity_archive.
Inputs
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
typestring- Return only reasons of this type. Allowed values: hired, non-hired. Example: non-hiredone of
hirednon-hired
lever_contact_getRetrieve the contact record of a person, shared across all of their opportunities.Read-onlyGet Contact
Retrieve the contact record of a person, shared across all of their opportunities. Returns the contact with id, name, headline, location, emails, phones and isAnonymized. Use this to read a candidate's personal details. Use lever_opportunity_get for one candidacy. Requires a contact UID from the contact field of lever_opportunity_get.
Inputs
contact_idstringrequired- Contact UID. Get it from the contact field of lever_opportunity_get or lever_opportunities_list. Example: 7f23e772-f2cb-4ebb-b33f-54b872999992
lever_disposition_stages_listList the account's full pipeline configuration: every stage with its pipeline, rank and hasInterview, plus every archive reason.Read-onlyList Disposition Stages
List the account's full pipeline configuration: every stage with its pipeline, rank and hasInterview, plus every archive reason. Returns stages and archive reasons in one response. Use this to map Lever's pipeline to another system. Use lever_stages_list or lever_archive_reasons_list for a single list.
Inputs
This tool takes no inputs.
lever_diversity_survey_getRetrieve the active diversity survey that applies to a posting's location, or to a candidate-selected country.Read-onlyGet Diversity Survey
Retrieve the active diversity survey that applies to a posting's location, or to a candidate-selected country. Returns the survey with id, text, instructions, locations and fields (questions with their answer options). Use this to build the diversitySurvey answers for lever_posting_apply.
Inputs
posting_idstringrequired- Posting UID. Get it from lever_postings_list. Example: f2f01e16-27f8-4711-a728-7d49499795a0
country_codestring- Country code used to pick a candidate self-select location survey. Example: US
lever_feedback_getRetrieve one feedback form on an opportunity.Read-onlyGet Feedback
Retrieve one feedback form on an opportunity. Returns the feedback form with its fields and values, user, panel, interview and timestamps. Use this when you have a feedback ID. Use lever_feedback_list to browse feedback.
Inputs
feedback_idstringrequired- Feedback form UID. Get it from lever_feedback_list. Example: c64fb192-d6d8-42dc-ac82-47cb87e9839c
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
expandarray- Related objects to return inline as full objects instead of IDs. Allowed values: user. Example: ["user"]
lever_feedback_listList the feedback forms submitted for an opportunity, typically completed by interviewers.Read-onlyList Feedback
List the feedback forms submitted for an opportunity, typically completed by interviewers. Returns feedback forms with id, type, text, baseTemplateId, fields with their values, user, panel, interview and timestamps. Use this to read interview scorecards. Use lever_feedback_get for one form and lever_notes_list for free-form notes.
Inputs
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
expandarray- Related objects to return inline as full objects instead of IDs. Allowed values: user. Example: ["user"]
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
lever_feedback_template_getRetrieve one feedback template.Read-onlyGet Feedback Template
Retrieve one feedback template. Returns the template with id, text, group, instructions, stage and fields. Use this to read a template's field IDs and options. Use lever_feedback_templates_list to browse templates.
Inputs
feedback_template_idstringrequired- Feedback template UID. Get it from lever_feedback_templates_list. Example: 5b0f589c-b0c2-4e84-bf83-0f2ca48fc48a
lever_feedback_templates_listList the active feedback templates in the Lever account, including the default no-feedback template.Read-onlyList Feedback Templates
List the active feedback templates in the Lever account, including the default no-feedback template. Returns templates with id, text, group, instructions, stage and fields (each field's id, type, text and options). Use this to find a baseTemplateId and field IDs before lever_feedback_create. Use lever_feedback_template_get for one template.
Inputs
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
lever_file_getRetrieve one file's metadata on an opportunity.Read-onlyGet File
Retrieve one file's metadata on an opportunity. Returns the file with id, name, ext, size, status, uploadedAt and downloadUrl. Use this when you have a file ID. Use lever_files_list to browse files.
Inputs
file_idstringrequired- File UID. Get it from lever_files_list. Example: b02a3b97-dc41-48e3-b003-44d211ed2a4c
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
lever_files_listList the files attached to an opportunity, such as cover letters and portfolios, optionally by upload date.Read-onlyList Files
List the files attached to an opportunity, such as cover letters and portfolios, optionally by upload date. Returns files with id, name, ext, size, status, uploadedAt and downloadUrl. Use this to see a candidate's attachments. Use lever_resumes_list for resumes.
Inputs
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
uploaded_at_endinteger- Return files uploaded at or before this time. Unix timestamp in milliseconds. Example: 1407460069499
uploaded_at_startinteger- Return files uploaded at or after this time. Unix timestamp in milliseconds. Example: 1407460069499
lever_form_template_getRetrieve one profile form template.Read-onlyGet Profile Form Template
Retrieve one profile form template. Returns the template with id, text, group, instructions, secretByDefault and fields. Use this to read the fields a profile form must contain. Use lever_form_templates_list to browse templates.
Inputs
form_template_idstringrequired- Profile form template UID. Get it from lever_form_templates_list. Example: 5b0f589c-b0c2-4e84-bf83-0f2ca48fc48a
lever_form_templates_listList the active profile form templates in the Lever account.Read-onlyList Profile Form Templates
List the active profile form templates in the Lever account. Returns templates with id, text, group, instructions, secretByDefault and fields; use include to return only some attributes. Use this to find a baseTemplateId and its fields before lever_profile_form_create.
Inputs
includearray- Return only these attributes. Allowed values: text, group, fields. Example: ["text", "group"]
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
lever_interview_getRetrieve one interview on an opportunity.Read-onlyGet Interview
Retrieve one interview on an opportunity. Returns the interview with panel, subject, interviewers, date, duration, location, feedback forms and conference details. Use this when you have an interview ID. Use lever_interviews_list to browse.
Inputs
interview_idstringrequired- Interview UID. Get it from lever_interviews_list. Example: 6ff55c8e-fe04-4eb4-835a-630b1c0da421
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
expandarray- Related objects to return inline as full objects instead of IDs. Allowed values: user, stage, postings, feedbackForms. Example: ["user"]
lever_interviews_listList the interviews scheduled for an opportunity.Read-onlyList Interviews
List the interviews scheduled for an opportunity. Returns interviews with id, panel, subject, interviewers, date, duration, location, timezone, feedbackForms, stage, canceledAt and conferences. Use this to see a candidate's interview schedule. Use lever_panels_list for panels and lever_interview_get for one interview.
Inputs
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
expandarray- Related objects to return inline as full objects instead of IDs. Allowed values: user, stage, postings, feedbackForms. Example: ["user"]
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
lever_note_getRetrieve one note on an opportunity.Read-onlyGet Note
Retrieve one note on an opportunity. Returns the note with id, text, fields, user, secret and timestamps. Use this when you have a note ID. Use lever_notes_list to browse notes.
Inputs
note_idstringrequired- Note UID. Get it from lever_notes_list. Example: b1dbbcfe-281c-46a0-8f51-57049158d3f3
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
expandarray- Related objects to return inline as full objects instead of IDs. Allowed values: user. Example: ["user"]
lever_notes_listList the notes on an opportunity's profile.Read-onlyList Notes
List the notes on an opportunity's profile. Returns a page of notes with id, text, fields (the note values), user, secret, createdAt and completedAt. Use this to read the discussion on a candidate. Use lever_note_get for one note and lever_feedback_list for interview feedback.
Inputs
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
expandarray- Related objects to return inline as full objects instead of IDs. Allowed values: user. Example: ["user"]
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
lever_offers_listList the offers made on an opportunity.Read-onlyList Offers
List the offers made on an opportunity. Returns offers with id, status (draft, approval-sent, approved, sent, sent-manually, opened, denied, signed), creator, fields, signatures, sentDocument, signedDocument and timestamps. Use this to check offer status and terms for a candidate.
Inputs
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
expandarray- Related objects to return inline as full objects instead of IDs. Allowed values: creator. Example: ["creator"]
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
lever_opportunities_deleted_listList opportunities that were deleted from the Lever account, optionally within a deletion time window.Read-onlyList Deleted Opportunities
List opportunities that were deleted from the Lever account, optionally within a deletion time window. Returns a page of deleted opportunities with id, deletedAt and deletedBy. Use this to sync deletions into another system. Use lever_opportunities_list for live opportunities.
Inputs
deleted_at_endinteger- Return opportunities deleted at or before this time. Unix timestamp in milliseconds. Example: 1407460069499
deleted_at_startinteger- Return opportunities deleted at or after this time. Unix timestamp in milliseconds. Example: 1407460069499
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
lever_opportunities_listList opportunities (candidacies) in the Lever account, filtered by tag, email, stage, posting, contact, origin, archive state or date ranges.Read-onlyList Opportunities
List opportunities (candidacies) in the Lever account, filtered by tag, email, stage, posting, contact, origin, archive state or date ranges. Returns a page of opportunity objects with id, name, contact, stage, tags, sources, owner, archived and timestamps, plus next and hasNext for paging. Use this to find candidates or browse a pipeline. Use lever_opportunity_get when you already have an opportunity ID.
Inputs
advanced_at_endinteger- Return opportunities advanced to their current stage at or before this time. Unix timestamp in milliseconds. Example: 1407460069499
advanced_at_startinteger- Return opportunities advanced to their current stage at or after this time. Unix timestamp in milliseconds. Example: 1407460069499
archive_reason_idarray- Return opportunities archived with any of these archive reason UIDs. Get them from lever_archive_reasons_list. Example: ["63dd55b2-a99f-4e7b-985f-22c7bf80ab42"]
archivedboolean- true returns only archived opportunities, false only active ones. Omit to return both. Example: false
archived_at_endinteger- Return opportunities archived at or before this time. Unix timestamp in milliseconds. Example: 1407460069499
archived_at_startinteger- Return opportunities archived at or after this time. Unix timestamp in milliseconds. Example: 1407460069499
archived_posting_idarray- Return opportunities whose application to any of these posting UIDs was archived. Example: ["f2f01e16-27f8-4711-a728-7d49499795a0"]
confidentialitystring- Filter by confidentiality. Lever defaults to non-confidential; pass all to include confidential opportunities (requires confidential access). Allowed values: confidential, non-confidential, all. Example: allone of
confidentialnon-confidentialall contact_idarray- Return opportunities that belong to any of these contact UIDs (all candidacies of one person). Example: ["7f23e772-f2cb-4ebb-b33f-54b872999992"]
created_at_endinteger- Return opportunities created at or before this time. Unix timestamp in milliseconds. Example: 1407460069499
created_at_startinteger- Return opportunities created at or after this time. Unix timestamp in milliseconds. Example: 1407460069499
emailstring- Return only opportunities whose contact has this email address (matched against the canonicalized email). Example: shane@example.com
expandarray- Related objects to return inline as full objects instead of IDs. Allowed values: applications, stage, owner, followers, sourcedBy, contact. Example: ["applications"]
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
originarray- Return opportunities with any of these origins. Allowed values: agency, applied, internal, referred, sourced, university. Example: ["sourced"]
posting_idarray- Return opportunities applied to any of these posting UIDs. Get posting UIDs from lever_postings_list. Example: ["f2f01e16-27f8-4711-a728-7d49499795a0"]
snoozedboolean- true returns only snoozed opportunities, false only unsnoozed ones. Omit to return both. Example: false
sourcearray- Return opportunities that have any of these sources (for example LinkedIn or Referral). Example: ["LinkedIn"]
stage_idarray- Return opportunities currently in any of these stage UIDs. Get stage UIDs from lever_stages_list. Example: ["00922a60-7c15-422b-b086-f62000824fd7"]
tagarray- Return opportunities that have any of these tags. Tags are case sensitive. Example: ["San Francisco"]
updated_at_endinteger- Return opportunities with any change at or before this time. Unix timestamp in milliseconds. Example: 1407460069499
updated_at_startinteger- Return opportunities with any change at or after this time. Unix timestamp in milliseconds. Example: 1407460069499
lever_opportunity_file_actions_listList file activity (file added, resume imported, file removed) on one opportunity, newest first.Read-onlyList Opportunity File Actions
List file activity (file added, resume imported, file removed) on one opportunity, newest first. Returns a page of file actions with id, type, occurredAt, user and file metadata, plus next and hasNext. Use this to track document changes since a time. Use lever_files_list for the current files.
Inputs
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
occurred_at_endinteger- Return file actions that occurred before this time (exclusive). Unix timestamp in milliseconds. Example: 1407460069499
occurred_at_startinteger- Return file actions that occurred at or after this time (inclusive). Unix timestamp in milliseconds. Example: 1407460069499
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
lever_opportunity_getRetrieve one opportunity (candidacy) by its UID.Read-onlyGet Opportunity
Retrieve one opportunity (candidacy) by its UID. Returns the opportunity with name, headline, contact, emails, phones, links, stage, stageChanges, tags, sources, origin, owner, followers, applications, archived and urls. Use this when you have an opportunity ID. Use lever_opportunities_list to search, and lever_contact_get for the person's contact record.
Inputs
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
expandarray- Related objects to return inline as full objects instead of IDs. Allowed values: applications, stage, owner, followers, sourcedBy, contact. Example: ["applications"]
lever_panel_getRetrieve one interview panel on an opportunity.Read-onlyGet Interview Panel
Retrieve one interview panel on an opportunity. Returns the panel with its interviews, timezone, start, end and externallyManaged flag. Use this when you have a panel ID. Use lever_panels_list to browse panels.
Inputs
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
panel_idstringrequired- Interview panel UID. Get it from lever_panels_list. Example: fdb313e8-13c5-47de-9e51-6a21a4d76ff6
expandarray- Related objects to return inline as full objects instead of IDs. Allowed values: user, stage. Example: ["user"]
lever_panels_listList the interview panels on an opportunity.Read-onlyList Interview Panels
List the interview panels on an opportunity. Returns panels with id, applications, start, end, timezone, note, externallyManaged, externalUrl, stage, user and their interviews. Use this to see how a candidate's interviews are grouped. Use lever_interviews_list for a flat list of interviews.
Inputs
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
expandarray- Related objects to return inline as full objects instead of IDs. Allowed values: user, stage. Example: ["user"]
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
lever_posting_application_questions_getRetrieve the application form of a posting: personal information fields, custom question sets, URL questions and EEO questions, each marked required or optional.Read-onlyGet Posting Application Questions
Retrieve the application form of a posting: personal information fields, custom question sets, URL questions and EEO questions, each marked required or optional. Returns the form structure with field ids, types, text and options. Use this before lever_posting_apply to know which fields to send and in what order. Use lever_posting_get for the job description.
Inputs
posting_idstringrequired- Posting UID. Get it from lever_postings_list. Example: f2f01e16-27f8-4711-a728-7d49499795a0
lever_posting_getRetrieve one job posting, including its description content.Read-onlyGet Posting
Retrieve one job posting, including its description content. Returns the posting with text, state, categories, content (description, lists, closing), distributionChannels, owner, hiringManager, requisitionCodes, workplaceType and urls. Use this to read a role's details. Use lever_posting_application_questions_get for its application form and lever_postings_list to find postings.
Inputs
posting_idstringrequired- Posting UID. Get it from lever_postings_list. Example: f2f01e16-27f8-4711-a728-7d49499795a0
distributionstring- Which custom application questions to return: internal or external. Lever returns both when omitted. Example: externalone of
internalexternal expandarray- Related objects to return inline as full objects instead of IDs. Allowed values: user, owner, hiringManager, followers. Example: ["user"]
lever_posting_users_listList the users and roles that can access a posting's candidates, based on their permissions.Read-onlyList Posting Users
List the users and roles that can access a posting's candidates, based on their permissions. Returns the posting summary, users (id, name, email, inheritedFromRoleId) and roles (id, name, isReadOnly). Use this to see who can view a posting's candidates. Use lever_users_list for every user in the account.
Inputs
posting_idstringrequired- Posting UID. Get it from lever_postings_list. Example: f2f01e16-27f8-4711-a728-7d49499795a0
lever_postings_deleted_listList postings deleted from the Lever account within a time window of at most 30 days.Read-onlyList Deleted Postings
List postings deleted from the Lever account within a time window of at most 30 days. Returns a page of deleted postings with id and deletedAt. Use this to sync posting deletions. Use lever_postings_list for live postings.
Inputs
deleted_at_endintegerrequired- End of the deletion window (exclusive). The window may not exceed 30 days. Unix timestamp in milliseconds. Example: 1407460069499
deleted_at_startintegerrequired- Start of the deletion window (inclusive). The window may not exceed 30 days. Unix timestamp in milliseconds. Example: 1407460069499
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
lever_postings_listList job postings in the Lever account, filtered by state, team, department, location, work type or tag.Read-onlyList Postings
List job postings in the Lever account, filtered by state, team, department, location, work type or tag. Returns a page of postings with id, text, state, distributionChannels, categories, tags, owner, hiringManager, urls and, when included, content and followers. Use this to find open roles. Published postings are returned only for the public job site unless distributionChannel is set. Use lever_posting_get for one posting.
Inputs
commitmentarray- Return postings with any of these work types, for example Full-time (case sensitive). Example: ["Full-time"]
confidentialitystring- Filter by confidentiality. Lever defaults to non-confidential; pass all to include confidential postings. Allowed values: confidential, non-confidential, all. Example: allone of
confidentialnon-confidentialall departmentarray- Return postings for any of these departments (case sensitive). Example: ["Engineering"]
distributionChannelarray- For published postings, which job sites to include. Pass both public and internal to get every published posting. Example: ["public", "internal"]
expandarray- Related objects to return inline as full objects instead of IDs. Allowed values: user, owner, hiringManager, followers. Example: ["user"]
groupstring- Group the results by one category. Allowed values: location, team, department, commitment. Example: teamone of
locationteamdepartmentcommitment includearray- Optional fields to add to each posting. Allowed values: content, followers. Example: ["content"]
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
locationarray- Return postings for any of these locations (case sensitive). Example: ["San Francisco"]
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
statestring- Filter by posting state. Allowed values: published, internal (unlisted), closed, draft, pending, rejected. Example: publishedone of
publishedinternalcloseddraftpendingrejected tagarray- Return postings with any of these tags (case sensitive). Example: ["engineering"]
teamarray- Return postings for any of these teams (case sensitive). Example: ["Sales"]
updated_at_endinteger- Return postings updated at or before this time. Can only be combined with confidentiality. Unix timestamp in milliseconds. Example: 1407460069499
updated_at_startinteger- Return postings updated at or after this time. Can only be combined with confidentiality. Unix timestamp in milliseconds. Example: 1407460069499
lever_profile_form_getRetrieve one completed profile form on an opportunity.Read-onlyGet Profile Form
Retrieve one completed profile form on an opportunity. Returns the form with its fields and values, user, stage and timestamps. Use this when you have a form ID. Use lever_profile_forms_list to browse forms.
Inputs
form_idstringrequired- Profile form UID. Get it from lever_profile_forms_list. Example: d0cc2b88-ccd4-4947-8f1b-97df6166904b
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
expandarray- Related objects to return inline as full objects instead of IDs. Allowed values: user, stage. Example: ["user"]
lever_profile_forms_listList the completed profile forms on an opportunity, such as offer information forms.Read-onlyList Profile Forms
List the completed profile forms on an opportunity, such as offer information forms. Returns forms with id, text, baseTemplateId, fields with values, user, stage and timestamps. Use this to read structured data recorded on a candidate. Use lever_feedback_list for interview feedback.
Inputs
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
expandarray- Related objects to return inline as full objects instead of IDs. Allowed values: user, stage. Example: ["user"]
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
lever_referral_getRetrieve one referral form on an opportunity.Read-onlyGet Referral
Retrieve one referral form on an opportunity. Returns the referral with its fields, referrer, user, stage and timestamps. Use this when you have a referral ID. Use lever_referrals_list to browse referrals.
Inputs
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
referral_idstringrequired- Referral UID. Get it from lever_referrals_list. Example: 093e77a4-7424-4420-962a-41b4936630b4
expandarray- Related objects to return inline as full objects instead of IDs. Allowed values: referrer, user, stage. Example: ["referrer"]
lever_referrals_listList the referral forms on an opportunity.Read-onlyList Referrals
List the referral forms on an opportunity. Returns referrals with id, text, fields (referrer name, relationship, comments), referrer, user, stage and timestamps. Use this to see who referred a candidate and why.
Inputs
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
expandarray- Related objects to return inline as full objects instead of IDs. Allowed values: referrer, user, stage. Example: ["referrer"]
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
lever_requisition_field_getRetrieve one custom requisition field definition.Read-onlyGet Requisition Field
Retrieve one custom requisition field definition. Returns the field with id, text, type, isRequired, subfields and options. Use this when you know a field id. Use lever_requisition_fields_list for every field.
Inputs
requisition_field_idstringrequired- Requisition field id (snake_case). Get it from lever_requisition_fields_list. Example: cost_center
lever_requisition_fields_listList the custom requisition field definitions in the Lever account.Read-onlyList Requisition Fields
List the custom requisition field definitions in the Lever account. Returns fields with id, text, type (number, text, date, object or dropdown), isRequired, subfields and options. Use this to build the customFields of lever_requisition_create.
Inputs
isRequiredboolean- true returns only required fields, false only optional ones. Example: true
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
typestring- Return only fields of this type. Allowed values: number, text, date, object, dropdown. Example: objectone of
numbertextdateobjectdropdown
lever_requisition_getRetrieve one requisition.Read-onlyGet Requisition
Retrieve one requisition. Returns the requisition with code, name, status, headcount, compensation band, hiring manager, owner, postings, custom fields, approval and time-to-fill dates. Use this when you have a requisition ID. Use lever_requisitions_list to search.
Inputs
requisition_idstringrequired- Requisition UID. Get it from lever_requisitions_list. Example: 52881d44-4f95-4fcb-bf28-2b344ea58889
expandarray- Related objects to return inline as full objects instead of IDs. Allowed values: creator, hiringManager, owner, postings. Example: ["creator"]
lever_requisitions_listList requisitions in the Lever account, filtered by status, requisition code, confidentiality or creation date.Read-onlyList Requisitions
List requisitions in the Lever account, filtered by status, requisition code, confidentiality or creation date. Returns a page of requisitions with id, requisitionCode, name, status, headcountTotal, headcountHired, hiringManager, owner, compensationBand, postings, customFields and approval. Use this to review headcount or find a requisition. Use lever_requisition_get when you have its ID.
Inputs
confidentialitystring- Filter by confidentiality. Lever defaults to non-confidential. Allowed values: confidential, non-confidential, all. Example: allone of
confidentialnon-confidentialall created_at_endinteger- Return requisitions created before this time. Unix timestamp in milliseconds. Example: 1407460069499
created_at_startinteger- Return requisitions created at or after this time. Unix timestamp in milliseconds. Example: 1407460069499
expandarray- Related objects to return inline as full objects instead of IDs. Allowed values: creator, hiringManager, owner, postings. Example: ["creator"]
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
requisition_codestring- Return the requisition with this HRIS requisition code. Example: ENG-145
statusstring- Filter by status. Allowed values: open, onHold, closed, draft. Example: openone of
openonHoldcloseddraft
lever_resume_getRetrieve one resume's metadata and parsed data.Read-onlyGet Resume
Retrieve one resume's metadata and parsed data. Returns the resume with file metadata and parsedData (positions and schools). Use this when you have a resume ID. Use lever_resumes_list to browse resumes.
Inputs
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
resume_idstringrequired- Resume UID. Get it from lever_resumes_list. Example: 68b3e478-ff21-4529-bd29-23ed016042d7
lever_resumes_listList the resumes on an opportunity, optionally by upload date.Read-onlyList Resumes
List the resumes on an opportunity, optionally by upload date. Returns resumes with id, createdAt, file metadata (name, ext, size, downloadUrl) and parsedData (positions and schools). Use this to read a candidate's work history and education. Use lever_files_list for other attachments.
Inputs
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
uploaded_at_endinteger- Return resumes uploaded at or before this time. Unix timestamp in milliseconds. Example: 1407460069499
uploaded_at_startinteger- Return resumes uploaded at or after this time. Unix timestamp in milliseconds. Example: 1407460069499
lever_sources_listList every candidate source in the Lever account, such as Posting, Referral or LinkedIn.Read-onlyList Sources
List every candidate source in the Lever account, such as Posting, Referral or LinkedIn. Returns sources with text and count (the number of candidates with that source). Use this to find exact source names for filters and lever_opportunity_sources_add.
Inputs
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
lever_stage_getRetrieve one pipeline stage.Read-onlyGet Stage
Retrieve one pipeline stage. Returns the stage id and text. Use this to resolve a stage UID to its name. Use lever_stages_list for every stage.
Inputs
stage_idstringrequired- Stage UID. Get it from lever_stages_list or an opportunity's stage field. Example: 00922a60-7c15-422b-b086-f62000824fd7
lever_stages_listList the pipeline stages in the Lever account.Read-onlyList Stages
List the pipeline stages in the Lever account. Returns stages with id and text. Use this to get stage UIDs for lever_opportunity_stage_update and lever_opportunities_list. Use lever_disposition_stages_list for stages plus archive reasons with pipeline order.
Inputs
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
lever_user_getRetrieve one Lever user.Read-onlyGet User
Retrieve one Lever user. Returns the user with id, name, username, email, accessRole, photo, jobTitle, managerId, linkedContactIds and deactivatedAt. Use this when you have a user ID. Use lever_users_list to search by email or role.
Inputs
user_idstringrequired- User UID. Get it from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
lever_users_listList the users in the Lever account.Read-onlyList Users
List the users in the Lever account. Only active users are returned unless includeDeactivated is set. Returns a page of users with id, name, username, email, accessRole, jobTitle, managerId and deactivatedAt. Use this to find user IDs for perform_as, owners, interviewers and followers, or usernames for @-mentions. Use lever_user_get for one user.
Inputs
accessRolestring- Return users with this access role: super admin, admin, team member, limited team member, interviewer, or a custom role ID. Example: admin
emailstring- Return the user with this exact email address. Example: chandler@example.com
external_directory_idstring- Return the user with this external HR directory ID. Example: 12345
includeDeactivatedboolean- When true, deactivated users are included. Example: false
limitinteger- Maximum number of results to return per page, between 1 and 100. Lever defaults to its own page size when omitted. Example: 50
offsetstring- Pagination cursor. Pass the next value returned by the previous page of this list to fetch the following page. Omit for the first page. Example: 0.1414895548650.a6070140-33db-407c-91f5-2760e15c8e94
lever_contact_updateUpdate a contact's name, headline, location, emails or phones.WriteUpdate Contact
Update a contact's name, headline, location, emails or phones. Returns the updated contact object. Use this to correct a candidate's personal details across all their opportunities. Use lever_opportunity_links_add for web links. Requires a contact UID from the contact field of lever_opportunity_get.
- Idempotent
Inputs
contact_idstringrequired- Contact UID. Get it from the contact field of lever_opportunity_get or lever_opportunities_list. Example: 7f23e772-f2cb-4ebb-b33f-54b872999992
emailsarray- Email addresses for the contact. Example: ["cniehaus@dyad.org"]
headlinestring- Contact headline, typically previous companies or schools. Example: Dyad Industries
locationstring- Location as one free-text string, which Lever resolves into components, or an object with name, addressLine1, addressLine2, city, region, postalCode and country (ISO 3166-1 alpha-2, required in the object form). Components omitted from the object are cleared. Example: "Toronto, ON, Canada"
namestring- Full name of the contact. Example: Cosima Niehaus
phonesarray- Phone numbers. Each item has a value and a type (mobile, home, work, skype or other). Example: [{"type": "mobile", "value": "123-456-7890"}]
lever_feedback_createSubmit a completed feedback form for an opportunity, based on a feedback template and optionally tied to an interview.WriteCreate Feedback
Submit a completed feedback form for an opportunity, based on a feedback template and optionally tied to an interview. Returns the created feedback form. Use this to record an interviewer's scorecard. Use lever_note_create for unstructured comments. Requires a feedback template from lever_feedback_templates_list and a perform_as user ID.
Inputs
baseTemplateIdstringrequired- UID of the feedback template the form is based on. Get it from lever_feedback_templates_list. Example: a12851f5-25cd-495b-9dae-b29b02d0b49d
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
perform_asstringrequired- UID of the Lever user to perform this action on behalf of. Lever requires it for this call and attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
completedAtinteger- Time the form was completed; defaults to now. Unix timestamp in milliseconds. Example: 1407460069499
createdAtinteger- Time the form was created; defaults to now. Unix timestamp in milliseconds. Example: 1407460069499
fieldValuesarray- Answers keyed by the template's field IDs. Each item has the field id and a value whose type matches the field (text, score, dropdown option text, list of strings for multiple select, and so on). Example: [{"id": "6ee25ace-dae2-4aa1-a1d2-9687464a691f", "value": "4 - Strong Hire"}]
interviewstring- Interview UID the feedback was submitted for. Required when panel is set, and it must belong to that panel. Example: 85110ec8-e33a-4997-a798-5affc854b7ce
panelstring- Interview panel UID the feedback belongs to. Required when interview is set. Get it from lever_panels_list. Example: 2cdfff3a-2d7e-4fa6-9a9b-25ba25b6a9f8
lever_feedback_updateUpdate the answers or completion time of a feedback form.WriteUpdate Feedback
Update the answers or completion time of a feedback form. Returns the updated feedback form. Use this to correct a submitted scorecard. Use lever_feedback_create for a new form. Requires a perform_as user ID from lever_users_list.
- Idempotent
Inputs
feedback_idstringrequired- Feedback form UID. Get it from lever_feedback_list. Example: c64fb192-d6d8-42dc-ac82-47cb87e9839c
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
perform_asstringrequired- UID of the Lever user to perform this action on behalf of. Lever requires it for this call and attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
completedAtinteger- Time the feedback was completed. Unix timestamp in milliseconds. Example: 1407460069499
fieldValuesarray- Answers to change, keyed by field ID. The value's type must match the field. Example: [{"id": "c0d040b7-5f83-4689-ad22-d20f04dfc2c7", "value": "3 - Yes"}]
lever_interview_createSchedule an interview inside an existing externally managed panel on an opportunity.WriteCreate Interview
Schedule an interview inside an existing externally managed panel on an opportunity. Returns the created interview. Use this to add an interview to a panel your integration created. Use lever_panel_create to create the panel and its first interviews together. Requires a panel UID from lever_panels_list and a perform_as user ID.
Inputs
dateintegerrequired- When the interview is scheduled to start. Unix timestamp in milliseconds. Example: 1407460069499
durationintegerrequired- Interview duration in minutes, at least 1. Example: 30
interviewersarrayrequired- Interviewers, at least one. Each item needs the user id and can set a feedbackTemplate UID for that interviewer. Example: [{"id": "412f5bf5-1509-4916-ba5b-8b16a5c3ce6d", "feedbackTemplate": "7fdd449e-0bb1-4ac8-9b96-9281c1dc2099"}]
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
panelstringrequired- UID of the interview panel the interview belongs to. The panel must be externally managed (created through the API). Get it from lever_panels_list. Example: fdb313e8-13c5-47de-9e51-6a21a4d76ff6
perform_asstringrequired- UID of the Lever user to perform this action on behalf of. Lever requires it for this call and attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
conferenceDataobject- Video meeting details. conferenceUrl (http or https, required in the object) is the join link; conferenceSolution names the provider, for example zoom, teams or meet. Example: {"conferenceUrl": "https://zoom.us/j/1234567890", "conferenceSolution": "zoom"}
feedbackReminderstring- How often to remind interviewers to submit feedback. Allowed values: once, daily, frequently (every 6 hours, Lever's default), none. Example: onceone of
oncedailyfrequentlynone feedbackTemplatestring- Feedback template UID for the interview. Get it from lever_feedback_templates_list. Example: 7fdd449e-0bb1-4ac8-9b96-9281c1dc2099
locationstring- Interview location, such as a room name or a phone number. Example: Call - (123) 456-7891
notestring- Interview note, such as the schedule. Example: 6:00 - 6:30 pm - Rachel Green - Call
subjectstring- Interview subject. Example: On-site interview - Kristoff Bjorgman - Office Manager
lever_interview_updateReplace an interview in an externally managed panel.WriteUpdate Interview
Replace an interview in an externally managed panel. Send the whole interview; fields left out are removed. Returns the updated interview. Use this to reschedule or edit an API-created interview. Interviews created in the Lever app cannot be updated. Requires a perform_as user ID from lever_users_list.
- Idempotent
Inputs
dateintegerrequired- When the interview is scheduled to start. Unix timestamp in milliseconds. Example: 1407460069499
durationintegerrequired- Interview duration in minutes, at least 1. Example: 30
interview_idstringrequired- Interview UID. Get it from lever_interviews_list. Example: 6ff55c8e-fe04-4eb4-835a-630b1c0da421
interviewersarrayrequired- Interviewers, at least one. Each item needs the user id and can set a feedbackTemplate UID for that interviewer. Example: [{"id": "412f5bf5-1509-4916-ba5b-8b16a5c3ce6d", "feedbackTemplate": "7fdd449e-0bb1-4ac8-9b96-9281c1dc2099"}]
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
panelstringrequired- UID of the interview panel the interview belongs to. The panel must be externally managed (created through the API). Get it from lever_panels_list. Example: fdb313e8-13c5-47de-9e51-6a21a4d76ff6
perform_asstringrequired- UID of the Lever user to perform this action on behalf of. Lever requires it for this call and attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
conferenceDataobject- Video meeting details. conferenceUrl (http or https, required in the object) is the join link; conferenceSolution names the provider, for example zoom, teams or meet. Example: {"conferenceUrl": "https://zoom.us/j/1234567890", "conferenceSolution": "zoom"}
feedbackReminderstring- How often to remind interviewers to submit feedback. Allowed values: once, daily, frequently (every 6 hours, Lever's default), none. Example: onceone of
oncedailyfrequentlynone feedbackTemplatestring- Feedback template UID for the interview. Get it from lever_feedback_templates_list. Example: 7fdd449e-0bb1-4ac8-9b96-9281c1dc2099
locationstring- Interview location, such as a room name or a phone number. Example: Call - (123) 456-7891
notestring- Interview note, such as the schedule. Example: 6:00 - 6:30 pm - Rachel Green - Call
subjectstring- Interview subject. Example: On-site interview - Kristoff Bjorgman - Office Manager
lever_note_createAdd a note to an opportunity's profile, or a threaded comment on an existing note when note_id is set.WriteCreate Note
Add a note to an opportunity's profile, or a threaded comment on an existing note when note_id is set. @-mention users by username in the text to notify them. Returns the noteId of the created note. Use this to record context on a candidate. Use lever_feedback_create for structured interview feedback.
Inputs
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
valuestringrequired- Body of the note. Include @username to mention and notify a user; usernames come from lever_users_list. Example: Hey @melissa please review this candidate!
createdAtinteger- Creation time for a historical note. Cannot be in the future; defaults to now. Unix timestamp in milliseconds. Example: 1407460069499
note_idstring- UID of an existing note to add this text as a threaded comment on. Omit to start a new note. Example: b1dbbcfe-281c-46a0-8f51-57049158d3f3
notifyFollowersboolean- When true, notifies every user following the candidate. Lever defaults to false. Example: false
perform_asstring- UID of the Lever user to perform this action on behalf of. Optional; when set, Lever attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
scoreinteger- Optional score from 1 to 4: 1 Strong No, 2 No, 3 Yes, 4 Strong Yes. Example: 3one of
1234 secretboolean- When true, only users with Sensitive Information Privileges for the candidate's postings and mentioned users can see the note. Lever defaults to false. Example: false
lever_note_updateReplace the full contents of a note that was created through the API, including all of its comments.WriteUpdate Note
Replace the full contents of a note that was created through the API, including all of its comments. Returns the noteId of the updated note. Use this to edit an API-created note. Notes created in the Lever app cannot be updated. Use lever_note_create to add a comment instead.
- Idempotent
Inputs
note_idstringrequired- UID of a note originally created through the API. Get it from lever_notes_list. Example: b1dbbcfe-281c-46a0-8f51-57049158d3f3
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
valuesarrayrequired- Every comment the note should contain after the update; the whole note is replaced. Each item needs a value and can carry createdAt (milliseconds) and score (1 to 4, applied to the whole thread). Example: [{"value": "Strong system design round", "createdAt": 1622151397144}]
lever_opportunity_archiveArchive an opportunity with an archive reason, or change the reason on an already archived opportunity.WriteArchive Opportunity
Archive an opportunity with an archive reason, or change the reason on an already archived opportunity. A Hired reason plus a requisition marks the candidate hired against that requisition. Returns the updated opportunity object with its archived state. Use this to reject or hire a candidate. Use lever_opportunity_unarchive to return it to the active pipeline. Requires an archive reason UID from lever_archive_reasons_list.
- Idempotent
Inputs
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
reasonstringrequired- UID of the archive reason. Get it from lever_archive_reasons_list (type hired or non-hired). Example: 63dd55b2-a99f-4e7b-985f-22c7bf80ab42
cleanInterviewsboolean- When true, removes pending interviews from the opportunity as it is archived. Lever defaults to false. Example: true
perform_asstring- UID of the Lever user to perform this action on behalf of. Optional; when set, Lever attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
requisitionIdstring- Requisition UID to hire against, used with a Hired reason. Any active offer must be signed and tied to a posting linked to this requisition. Example: 64e9c86b-03e9-42a5-871c-591d77f45609
lever_opportunity_createCreate a candidate opportunity in Lever from JSON details such as name, emails, phones, links, tags, sources, stage and posting.WriteCreate Opportunity
Create a candidate opportunity in Lever from JSON details such as name, emails, phones, links, tags, sources, stage and posting. Returns the created opportunity object, including its id and contact. Use this to add a sourced or referred candidate. Lever dedupes by email and links the new opportunity to an existing contact when one matches. Use lever_posting_apply to submit an application against a posting's form. Requires a perform_as user ID from lever_users_list.
Inputs
perform_asstringrequired- UID of the Lever user to perform this action on behalf of. Lever requires it for this call and attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
archivedobject- Create the opportunity already archived, for historical imports. Provide reason (an archive reason UID, required) and optionally archivedAt (milliseconds, must be after createdAt). Example: {"reason": "63dd55b2-a99f-4e7b-985f-22c7bf80ab42", "archivedAt": 1417588008760}
contactstring- UID of an existing contact to attach this opportunity to. When omitted, Lever dedupes by email. Example: 7f23e772-f2cb-4ebb-b33f-54b872999992
createdAtinteger- Creation time for importing a historical opportunity. Must be in the past; defaults to now. Unix timestamp in milliseconds. Example: 1407460069499
emailsarray- Candidate email addresses. Example: ["shane@example.com"]
followersarray- User UIDs to add as followers. The creator is always added. Example: ["8d49b010-cc6a-4f40-ace5-e86061c677ed"]
headlinestring- Candidate headline, typically previous companies or schools. Example: Brickly LLC, Vandelay Industries
linksarray- Candidate links such as a LinkedIn profile or personal website. Example: ["https://linkedin.com/in/shane-smith"]
locationstring- Candidate's current location as free text. Example: Oakland
namestring- Full name of the candidate. Example: Shane Smith
originstring- How the candidate was added. Allowed values: agency, applied, internal, referred, sourced, university. Example: sourcedone of
agencyappliedinternalreferredsourceduniversity ownerstring- User UID of the opportunity owner. Defaults to the perform_as user. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
perform_as_posting_ownerboolean- When true, the opportunity owner is set to the owner of the single posting given in postings. Requires exactly one posting UID in postings. Example: false
phonesarray- Candidate phone numbers. Each item has a value and an optional type (mobile, home, work, skype or other). Example: [{"value": "(123) 456-7891", "type": "mobile"}]
postingsarray- Posting UID to apply the candidate to. Lever accepts at most one posting per request; call again for each additional posting. Example: ["f2f01e16-27f8-4711-a728-7d49499795a0"]
sourcesarray- Sources to apply, for example LinkedIn. Sources that do not exist yet are created. Example: ["LinkedIn"]
stagestring- Stage UID to place the opportunity in. Lever uses the New Lead stage when omitted. Get stage UIDs from lever_stages_list. Example: 00922a60-7c15-422b-b086-f62000824fd7
tagsarray- Tags to apply. Tags that do not exist yet are created. Example: ["Senior", "Referral"]
lever_opportunity_links_addAdd web links to the contact behind an opportunity.WriteAdd Contact Links
Add web links to the contact behind an opportunity. Returns the updated opportunity object with its links. Use this to attach profile URLs such as LinkedIn or GitHub. Use lever_opportunity_links_remove to take links off.
Inputs
linksarrayrequired- Links to add. Example: ["https://linkedin.com/in/shane-smith"]
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
perform_asstring- UID of the Lever user to perform this action on behalf of. Optional; when set, Lever attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
lever_opportunity_links_removeRemove web links from the contact behind an opportunity.WriteRemove Contact Links
Remove web links from the contact behind an opportunity. Returns the updated opportunity object with its links. Use this to remove profile URLs. Use lever_opportunity_links_add to add links.
Inputs
linksarrayrequired- Links to remove. Example: ["https://linkedin.com/in/shane-smith"]
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
perform_asstring- UID of the Lever user to perform this action on behalf of. Optional; when set, Lever attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
lever_opportunity_sources_addAdd one or more sources to an opportunity.WriteAdd Opportunity Sources
Add one or more sources to an opportunity. Returns the updated opportunity object with its sources. Use this to record where a candidate came from. Sources that do not exist yet are created. Use lever_opportunity_sources_remove to take sources off.
Inputs
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
sourcesarrayrequired- Sources to add, exactly as shown in Lever. Example: ["LinkedIn"]
perform_asstring- UID of the Lever user to perform this action on behalf of. Optional; when set, Lever attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
lever_opportunity_sources_removeRemove one or more sources from an opportunity.WriteRemove Opportunity Sources
Remove one or more sources from an opportunity. Returns the updated opportunity object with its sources. Use this to remove sources. Use lever_opportunity_sources_add to add sources.
Inputs
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
sourcesarrayrequired- Sources to remove, exactly as shown in Lever. Example: ["LinkedIn"]
perform_asstring- UID of the Lever user to perform this action on behalf of. Optional; when set, Lever attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
lever_opportunity_stage_updateMove an opportunity to a different pipeline stage.WriteUpdate Opportunity Stage
Move an opportunity to a different pipeline stage. Returns the updated opportunity object. Use this to advance or move back a candidate. Use lever_opportunity_archive to reject or hire instead. Requires a stage UID from lever_stages_list.
- Idempotent
Inputs
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
stagestringrequired- UID of the stage to move the opportunity to. Get stage UIDs from lever_stages_list. Example: 00922a60-7c15-422b-b086-f62000824fd7
perform_asstring- UID of the Lever user to perform this action on behalf of. Optional; when set, Lever attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
lever_opportunity_unarchiveUnarchive an opportunity by clearing its archive reason, returning it to the active pipeline.WriteUnarchive Opportunity
Unarchive an opportunity by clearing its archive reason, returning it to the active pipeline. Returns the updated opportunity object. Use this to reopen a rejected or hired candidacy. Use lever_opportunity_archive to archive.
- Idempotent
Inputs
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
perform_asstring- UID of the Lever user to perform this action on behalf of. Optional; when set, Lever attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
lever_panel_createCreate an interview panel with one or more interviews on an opportunity.WriteCreate Interview Panel
Create an interview panel with one or more interviews on an opportunity. The panel is marked externally managed. Returns the created panel with its interviews. Use this to schedule a candidate's interviews from an external scheduler. Use lever_interview_create to add an interview to an existing panel. Requires interviewer user IDs and a perform_as user ID from lever_users_list.
Inputs
interviewsarrayrequired- Interviews in the panel, at least one. Each item has interviewers (list of {id, feedbackTemplate}), date (milliseconds), duration (minutes) and optionally subject, note, location, feedbackTemplate and feedbackReminder. On update, keep the id of existing interviews and omit id for new ones. Example: [{"subject": "On-site interview", "interviewers": [{"id": "412f5bf5-1509-4916-ba5b-8b16a5c3ce6d"}], "date": 1423188000000, "duration": 30}]
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
perform_asstringrequired- UID of the Lever user to perform this action on behalf of. Lever requires it for this call and attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
timezonestringrequired- IANA time zone the panel is scheduled in. Example: America/Los_Angeles
applicationsarray- Application UIDs the panel is for. Lever defaults to all active applications on the profile; an empty list is invalid. Example: ["7988b225-3cc1-44f3-8fcb-bae013cc490d"]
externalUrlstring- Link to the panel in an external scheduling system. Example: https://scheduler.example.com/panels/123
feedbackReminderstring- How often to remind interviewers to submit feedback. Allowed values: once, daily (Lever's default for panels), frequently (every 6 hours), none. Example: dailyone of
oncedailyfrequentlynone notestring- Panel note. Example: Panel for Rachel
lever_panel_updateReplace an externally managed interview panel.WriteUpdate Interview Panel
Replace an externally managed interview panel. Send the whole panel; fields left out are removed. Returns the updated panel. Use this to reschedule a panel your integration created. Panels created in the Lever app cannot be updated. Requires a perform_as user ID from lever_users_list.
- Idempotent
Inputs
interviewsarrayrequired- Interviews in the panel, at least one. Each item has interviewers (list of {id, feedbackTemplate}), date (milliseconds), duration (minutes) and optionally subject, note, location, feedbackTemplate and feedbackReminder. On update, keep the id of existing interviews and omit id for new ones. Example: [{"subject": "On-site interview", "interviewers": [{"id": "412f5bf5-1509-4916-ba5b-8b16a5c3ce6d"}], "date": 1423188000000, "duration": 30}]
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
panel_idstringrequired- Interview panel UID. Get it from lever_panels_list. Example: fdb313e8-13c5-47de-9e51-6a21a4d76ff6
perform_asstringrequired- UID of the Lever user to perform this action on behalf of. Lever requires it for this call and attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
timezonestringrequired- IANA time zone the panel is scheduled in. Example: America/Los_Angeles
applicationsarray- Application UIDs the panel is for. Lever defaults to all active applications on the profile; an empty list is invalid. Example: ["7988b225-3cc1-44f3-8fcb-bae013cc490d"]
externalUrlstring- Link to the panel in an external scheduling system. Example: https://scheduler.example.com/panels/123
feedbackReminderstring- How often to remind interviewers to submit feedback. Allowed values: once, daily (Lever's default for panels), frequently (every 6 hours), none. Example: dailyone of
oncedailyfrequentlynone notestring- Panel note. Example: Panel for Rachel
lever_posting_applySubmit an application on behalf of a candidate to a published or unlisted (internal) posting.WriteApply To Posting
Submit an application on behalf of a candidate to a published or unlisted (internal) posting. Returns the applicationId of the created application. Use this to apply a candidate through the posting's form. Use lever_opportunity_create to add a sourced candidate without a form. Requires the posting's form from lever_posting_application_questions_get. File uploads need a uri from Lever's upload endpoint, which this connector does not cover.
Inputs
posting_idstringrequired- UID of a published or internal posting. Get it from lever_postings_list. Example: f2f01e16-27f8-4711-a728-7d49499795a0
acceptLanguagestring- Applicant Accept-Language string. Example: en-US,en;q=0.9
consentobject- Whether the candidate agrees to be contacted about future opportunities. Example: {"marketing": true}
customQuestionsarray- Answers to the posting's custom question sets. Each item has the question set id and fields, a list of {value} in the same order as the form. Example: [{"id": "75f54523-ff77-4307-a868-08392ee02cab", "fields": [{"value": "10 years of experience"}, {"value": ["JavaScript", "Ruby"]}]}]
diversitySurveyobject- Diversity survey answers: surveyId, optional candidateSelectedLocation (country code) and responses (each with questionId, questionText, questionType and answer). Get the survey from lever_diversity_survey_get. Example: {"surveyId": "b0d26744-60b2-4015-b125-b09fd5b95c1d", "responses": []}
eeoResponsesobject- Equal employment opportunity answers when the form asks for them, such as gender, race, veteran, disability, disabilitySignature and disabilitySignatureDate. Example: {"gender": "Female", "veteran": "I am not a Protected Veteran"}
ipAddressstring- Applicant IP address, used to detect the candidate's country for compliance. Example: 184.23.195.146
originstring- Whether this is an external or internal application. Allowed values: applied, internal. Lever defaults to applied. Example: appliedone of
appliedinternal personalInformationarray- Candidate details as name/value pairs, using the field names from lever_posting_application_questions_get, for example fullName, email, phone, currentCompany and additionalInformation. Example: [{"name": "fullName", "value": "Shane Smith"}, {"name": "email", "value": "shane@example.com"}]
refererstring- Referring URL of the application. Example: https://jobs.example.com/careers
send_confirmation_emailboolean- When true, Lever emails the applicant a confirmation. Lever defaults to false. Example: false
sourcestring- Source tag to add to the candidate. Example: Internal job site
timezonestring- Applicant IANA time zone. Example: America/New_York
urlsarray- Answers to URL questions as name/value pairs. Example: [{"name": "LinkedIn", "value": "https://linkedin.com/in/shane-smith"}]
userAgentstring- Applicant browser User-Agent string. Example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)
lever_posting_createCreate a job posting.WriteCreate Posting
Create a job posting. API-created postings skip the approval chain and default to draft. Returns the created posting with its id and urls. Use this to open a new role. Use lever_posting_update to change an existing posting. Requires a perform_as user ID from lever_users_list.
Inputs
categoriesobjectrequired- Posting categories. team, department and location are required; commitment (work type such as Full-time) is optional. Example: {"team": "Platform", "department": "Engineering", "location": "San Francisco", "commitment": "Full-time"}
perform_asstringrequired- UID of the Lever user to perform this action on behalf of. Lever requires it for this call and attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
textstringrequired- Job title of the posting. Example: Infrastructure Engineer
contentobject- Job description. descriptionHtml is the opening text, lists holds sections such as requirements (each with text and content as <li> HTML), and closingPostingHtml is the closing statement. HTML is limited to the tags Lever allows (div, p, span, br, b, i, s, u, a; li in lists). Example: {"descriptionHtml": "<div>Build our platform.</div>", "lists": [{"text": "Requirements", "content": "<li>5 years of Go</li>"}]}
distributionChannelsarray- Job sites a published posting appears on. Allowed values: public, internal. Lever defaults to both. Example: ["public", "internal"]
hiringManagerstring- User UID of the hiring manager. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
ownerstring- User UID of the posting owner, who manages the candidates applied to it. Defaults to the perform_as user. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
requisitionCodesarray- Requisition codes to link to the posting. Example: ["ENG-145"]
salaryDescriptionHtmlstring- Salary description shown on the posting, as HTML. Example: <p>Base salary plus equity.</p>
salaryRangeobject- Salary range with min, max, currency (ISO code) and interval such as per-year-salary. Example: {"min": 40000, "max": 60000, "currency": "USD", "interval": "per-year-salary"}
statestring- Posting state. Allowed values: published, internal (unlisted), closed, draft. Lever defaults to draft. Example: draftone of
publishedinternalcloseddraft tagsarray- Additional posting tags. Example: ["engineering", "high-priority"]
workplaceTypestring- Workplace type. Allowed values: onsite, remote, hybrid. Once set it cannot go back to unspecified. Example: remoteone of
onsiteremotehybrid
lever_posting_updatePartially update a job posting.WriteUpdate Posting
Partially update a job posting. Only the fields you send change. Returns the updated posting. Use this to change a posting's state, title, categories or description. Read it first with lever_posting_get to avoid overwriting edits made in Lever. Requires a perform_as user ID from lever_users_list.
Inputs
perform_asstringrequired- UID of the Lever user to perform this action on behalf of. Lever requires it for this call and attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
posting_idstringrequired- Posting UID. Get it from lever_postings_list. Example: f2f01e16-27f8-4711-a728-7d49499795a0
categoriesobject- Posting categories. Any of team, department, location and commitment (work type such as Full-time). Example: {"team": "Platform", "department": "Engineering", "location": "San Francisco", "commitment": "Full-time"}
contentobject- Job description. descriptionHtml is the opening text, lists holds sections such as requirements (each with text and content as <li> HTML), and closingPostingHtml is the closing statement. HTML is limited to the tags Lever allows (div, p, span, br, b, i, s, u, a; li in lists). Example: {"descriptionHtml": "<div>Build our platform.</div>", "lists": [{"text": "Requirements", "content": "<li>5 years of Go</li>"}]}
distributionChannelsarray- Job sites a published posting appears on. Allowed values: public, internal. Example: ["public", "internal"]
hiringManagerstring- User UID of the hiring manager. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
ownerstring- User UID of the posting owner, who manages the candidates applied to it. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
requisitionCodesarray- Requisition codes to link to the posting. Example: ["ENG-145"]
salaryDescriptionHtmlstring- Salary description shown on the posting, as HTML. Example: <p>Base salary plus equity.</p>
salaryRangeobject- Salary range with min, max, currency (ISO code) and interval such as per-year-salary. Example: {"min": 40000, "max": 60000, "currency": "USD", "interval": "per-year-salary"}
statestring- Posting state. Allowed values: published, internal (unlisted), closed, draft. Example: draftone of
publishedinternalcloseddraft tagsarray- Additional posting tags. Example: ["engineering", "high-priority"]
textstring- Job title of the posting. Example: Infrastructure Engineer
workplaceTypestring- Workplace type. Allowed values: onsite, remote, hybrid. Once set it cannot go back to unspecified. Example: remoteone of
onsiteremotehybrid
lever_profile_form_createAdd a completed profile form to an opportunity, based on a profile form template.WriteCreate Profile Form
Add a completed profile form to an opportunity, based on a profile form template. Returns the created form with its fields and values. Use this to record structured data such as offer details on a candidate. Requires a template from lever_form_templates_list; every template field must be sent.
Inputs
baseTemplateIdstringrequired- UID of the profile form template. Get it from lever_form_templates_list. Example: 806ad14a-2fe5-4b42-b2da-3f90dc0a16d9
fieldsarrayrequired- Every field of the template, in its order, each with its type, text and a value (null is allowed for optional fields). Example: [{"type": "date", "text": "Start Date", "value": 1418716800000}, {"type": "currency", "text": "Compensation", "value": 75000}]
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
perform_asstring- UID of the Lever user to perform this action on behalf of. Optional; when set, Lever attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
secretboolean- When true, only users with Sensitive Information Privileges for the candidate's postings can see the form. Example: false
lever_requisition_createCreate a requisition, typically pushed from an HRIS.WriteCreate Requisition
Create a requisition, typically pushed from an HRIS. The account must have API management of requisitions enabled by a Super Admin. Returns the created requisition with its Lever id. Use this to add headcount to Lever. Use lever_requisition_update to change one.
Inputs
headcountTotalintegerrequired- Total headcount on the requisition, as a number or the string unlimited. Example: 10
namestringrequired- Human-readable requisition name. Example: Senior Software Engineer, Platform
requisitionCodestringrequired- Unique requisition code from your HRIS. Example: ENG-145
backfillboolean- true for a backfill, false for new headcount. Lever defaults to false. Example: false
compensationBandobject- Compensation band with currency (ISO code), interval (per-year-salary, per-month-salary, semi-month-salary, bi-month-salary, bi-week-salary, per-week-salary, per-day-wage, per-hour-wage or one-time), min and max. Example: {"currency": "USD", "interval": "per-year-salary", "min": 100000, "max": 130000}
createdAtinteger- Requisition creation time; defaults to the time of the request. Unix timestamp in milliseconds. Example: 1407460069499
customFieldsobject- Custom field values keyed by requisition field id, flat or nested one level. Lever validates them against the account's requisition fields (see lever_requisition_fields_list). Example: {"cost_center": {"city": "New York", "campus_code": "9"}, "target_hire_date": 1452067200000}
employmentStatusstring- Work type. Allowed values: full-time, part-time, intern, contractor, temp-worker. Example: full-timeone of
full-timepart-timeinterncontractortemp-worker hiringManagerstring- Lever user UID of the hiring manager. Omit if the hiring manager is not a Lever user. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
internalNotesstring- Free-text notes visible to anyone who can see the requisition. Example: College grad hire -- little flexibility on salary
locationstring- Location of the requisition. Example: New York
ownerstring- Lever user UID of the requisition owner. Defaults to the user behind the connection. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
postingIdsarray- Posting UIDs linked to the requisition. Left unchanged when omitted. Example: ["f2f01e16-27f8-4711-a728-7d49499795a0"]
statusstring- Requisition status. Allowed values: open, onHold, closed, draft. Lever defaults to open; draft needs hybrid requisition management. Example: openone of
openonHoldcloseddraft teamstring- Team of the requisition. Example: Product Engineering
lever_requisition_updateReplace a requisition.WriteUpdate Requisition
Replace a requisition. Send every field you want to keep; omitted fields are cleared or reset to their defaults. Returns the updated requisition. Use this to sync HRIS changes. Read it first with lever_requisition_get so you resend unchanged fields.
- Idempotent
Inputs
headcountTotalintegerrequired- Total headcount on the requisition, as a number or the string unlimited. Example: 10
namestringrequired- Human-readable requisition name. Example: Senior Software Engineer, Platform
requisition_idstringrequired- Requisition UID. Get it from lever_requisitions_list. Example: 52881d44-4f95-4fcb-bf28-2b344ea58889
requisitionCodestringrequired- Unique requisition code from your HRIS. Example: ENG-145
backfillboolean- true for a backfill, false for new headcount. Lever defaults to false. Example: false
compensationBandobject- Compensation band with currency (ISO code), interval (per-year-salary, per-month-salary, semi-month-salary, bi-month-salary, bi-week-salary, per-week-salary, per-day-wage, per-hour-wage or one-time), min and max. Example: {"currency": "USD", "interval": "per-year-salary", "min": 100000, "max": 130000}
createdAtinteger- Requisition creation time; defaults to the time of the request. Unix timestamp in milliseconds. Example: 1407460069499
customFieldsobject- Custom field values keyed by requisition field id, flat or nested one level. Lever validates them against the account's requisition fields (see lever_requisition_fields_list). Example: {"cost_center": {"city": "New York", "campus_code": "9"}, "target_hire_date": 1452067200000}
employmentStatusstring- Work type. Allowed values: full-time, part-time, intern, contractor, temp-worker. Example: full-timeone of
full-timepart-timeinterncontractortemp-worker hiringManagerstring- Lever user UID of the hiring manager. Omit if the hiring manager is not a Lever user. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
internalNotesstring- Free-text notes visible to anyone who can see the requisition. Example: College grad hire -- little flexibility on salary
locationstring- Location of the requisition. Example: New York
ownerstring- Lever user UID of the requisition owner. Defaults to the user behind the connection. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
postingIdsarray- Posting UIDs linked to the requisition. Left unchanged when omitted. Example: ["f2f01e16-27f8-4711-a728-7d49499795a0"]
statusstring- Requisition status. Allowed values: open, onHold, closed, draft. An open, closed or on-hold requisition cannot go back to draft. Example: openone of
openonHoldcloseddraft teamstring- Team of the requisition. Example: Product Engineering
lever_feedback_deleteDelete a feedback form from an opportunity.DestructiveDelete Feedback
Delete a feedback form from an opportunity. Returns an empty response on success. Use this to remove a feedback form submitted in error. Requires a perform_as user ID from lever_users_list.
- Idempotent
Inputs
feedback_idstringrequired- Feedback form UID. Get it from lever_feedback_list. Example: c64fb192-d6d8-42dc-ac82-47cb87e9839c
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
perform_asstringrequired- UID of the Lever user to perform this action on behalf of. Lever requires it for this call and attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
lever_file_deleteDelete a file from an opportunity.DestructiveDelete File
Delete a file from an opportunity. Returns an empty response on success. Use this to remove an attachment. Requires a perform_as user ID from lever_users_list.
- Idempotent
Inputs
file_idstringrequired- File UID. Get it from lever_files_list. Example: b02a3b97-dc41-48e3-b003-44d211ed2a4c
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
perform_asstringrequired- UID of the Lever user to perform this action on behalf of. Lever requires it for this call and attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
lever_interview_deleteDelete an interview from an externally managed panel.DestructiveDelete Interview
Delete an interview from an externally managed panel. Deleting the last interview also deletes the panel. Returns an empty response on success. Use this to cancel one API-created interview. Use lever_panel_delete to remove a whole panel. Requires a perform_as user ID from lever_users_list.
- Idempotent
Inputs
interview_idstringrequired- Interview UID. Get it from lever_interviews_list. Example: 6ff55c8e-fe04-4eb4-835a-630b1c0da421
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
perform_asstringrequired- UID of the Lever user to perform this action on behalf of. Lever requires it for this call and attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
lever_note_deleteDelete a note that was created through the API.DestructiveDelete Note
Delete a note that was created through the API. Returns an empty response on success. Use this to remove an API-created note. Notes created in the Lever app cannot be deleted through the API.
- Idempotent
Inputs
note_idstringrequired- UID of a note originally created through the API. Get it from lever_notes_list. Example: b1dbbcfe-281c-46a0-8f51-57049158d3f3
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
lever_panel_deleteDelete an externally managed interview panel and its interviews.DestructiveDelete Interview Panel
Delete an externally managed interview panel and its interviews. Returns an empty response on success. Use this to cancel a panel your integration created. Use lever_interview_delete to remove a single interview. Requires a perform_as user ID from lever_users_list.
- Idempotent
Inputs
opportunity_idstringrequired- UID of the opportunity (one candidacy of a contact for a role). Get it from lever_opportunities_list (id field). Example: 250d8f03-738a-4bba-a671-8a3d73477145
panel_idstringrequired- Interview panel UID. Get it from lever_panels_list. Example: fdb313e8-13c5-47de-9e51-6a21a4d76ff6
perform_asstringrequired- UID of the Lever user to perform this action on behalf of. Lever requires it for this call and attributes the change to that user. Get user IDs from lever_users_list. Example: 8d49b010-cc6a-4f40-ace5-e86061c677ed
lever_requisition_deleteDelete a requisition from the Lever account.DestructiveDelete Requisition
Delete a requisition from the Lever account. Returns an empty response on success. Use this to remove a requisition created by mistake. Use lever_requisition_update with status closed to close it instead.
- Idempotent
Inputs
requisition_idstringrequired- Requisition UID. Get it from lever_requisitions_list. Example: 52881d44-4f95-4fcb-bf28-2b344ea58889
No tools match.