Guides
Signup For Free

Lever API Integration

Suggest Edits

These are the list of integration use cases supported by Knit for Lever API as part of the ATS category

Upload a Single File

  • ID: add_attachment_to_application
  • Operation: write
  • Entities:
  • Summary: The 'Upload a Single File' API endpoint allows users to upload a file to a specified opportunity. The request must be made using the POST method to the '/opportunities/:opportunity/files' URL, where ':opportunity' is the ID of the opportunity. The request must include a 'perform_as' query parameter to specify the user on whose behalf the upload is performed. The file must be included in the request body as a binary file with a maximum size of 30MB, and the request must be of type 'multipart/form-data'. Upon successful upload, the API returns a response containing details of the uploaded file, including its ID, download URL, extension, name, upload timestamp, status, and size. In case of an error, such as a timeout, an error response with a code and message is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a file

  • ID: delete_a_file
  • Operation: read
  • Entities: opportunity, offer, candidate
  • Summary: The 'Delete a file' API endpoint allows for the deletion of a specified file associated with an opportunity. The request must include the 'perform_as' header to specify the user on whose behalf the operation is performed. The endpoint requires the 'opportunity' and 'file' path parameters to identify the specific file to be deleted. An optional 'offset' query parameter can be used to skip a number of items before starting to collect the result set for pagination. Upon successful deletion, the API returns a 204 No Content response, indicating that the file has been successfully removed. The response includes details of the user who created the file. Note that the endpoint via /candidates/ is deprecated, and it is recommended to use the /opportunities/ endpoint for this operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Note

  • ID: delete_a_note
  • Operation: write
  • Entities: opportunity, note
  • Summary: The 'Delete a Note' API endpoint allows users to delete a note associated with a specific opportunity. This endpoint is restricted to notes created via the API and cannot delete notes created within the Lever application. The request requires the opportunity ID and note ID as path parameters, and the API key for authentication in the headers. A successful deletion will result in a 204 No Content response, indicating that the note has been successfully deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Panel

  • ID: delete_a_panel
  • Operation: write
  • Entities: opportunity, panel, user
  • Summary: This API endpoint deletes a panel associated with a specific opportunity. Only panels with 'externallyManaged' set to true can be deleted via this API. The request requires the opportunity ID and panel ID as path parameters, and a 'perform_as' query parameter to specify the user on whose behalf the delete operation is performed. The API key must be included in the headers for authentication. The endpoint returns a 204 No Content status upon successful deletion. Note that the endpoint via /candidates/ is deprecated, and the /opportunities/ endpoint should be used instead.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a requisition

  • ID: delete_a_requisition
  • Operation: write
  • Entities: requisition, lever account
  • Summary: The 'Delete a requisition' API allows users to remove a requisition from their Lever account using the DELETE method. The API requires the requisition's unique identifier as a path parameter. The request must include headers for 'Content-Type' set to 'application/json' and 'Authorization' with a basic authentication API key. Upon successful deletion, the API returns a 204 No Content status, indicating that the requisition has been successfully removed and no content is returned in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a requisition field

  • ID: delete_a_requisition_field
  • Operation: write
  • Entities: requisition field, account
  • Summary: The 'Delete a requisition field' API allows users to remove a requisition field from their account that is no longer in use. To perform this action, a DELETE request is sent to the specified endpoint with the requisition field identifier as a path parameter. The request must include the 'Content-Type' header set to 'application/json' and an 'Authorization' header for basic authentication using an API key. Upon successful deletion, the API returns a 204 No Content response, indicating that the requisition field has been successfully removed.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Webhook

  • ID: delete_a_webhook
  • Operation: write
  • Entities: webhook
  • Summary: The 'Delete a Webhook' API allows users to delete a specific webhook by its unique identifier. The request requires an API key for authentication, which should be included in the headers. The 'webhookId' is a required path parameter that specifies the webhook to be deleted. Upon successful deletion, the API returns a 204 No Content status, indicating that the webhook has been successfully removed.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete an interview

  • ID: delete_an_interview
  • Operation: write
  • Entities: panel, user, interview
  • Summary: The 'Delete an interview' API endpoint allows users to delete an interview from a panel. If the last interview in a panel is deleted, the panel itself will be deleted. This endpoint is specifically for deleting interviews within panels where 'externallyManaged' is true and cannot be used for interviews created within the Lever application. The endpoint requires the 'opportunity' and 'interview' IDs as path parameters and a 'perform_as' query parameter to specify the user on whose behalf the delete is performed. The API uses basic authentication with an API key. A successful request returns a 204 No Content response, indicating that the interview was successfully deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Feedback

  • ID: delete_feedback
  • Operation: write
  • Entities: opportunity, user, feedback
  • Summary: The Delete Feedback API allows you to delete a feedback form associated with a specific opportunity. The API requires the opportunity ID and feedback ID as path parameters, and a 'perform_as' query parameter to specify the user on whose behalf the delete operation is performed. The API key must be included in the headers for authentication. Upon successful deletion, the API returns a 204 No Content response, indicating that the feedback has been successfully deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a feedback template

  • ID: delete_feedback_template
  • Operation: write
  • Entities: feedback template, account
  • Summary: The 'Delete a feedback template' API endpoint allows users to delete a specific feedback template associated with their account. This endpoint requires the unique identifier of the feedback template to be specified in the path parameters. Only templates that were created via the 'Create a feedback template' endpoint can be deleted using this endpoint. The request must be authenticated using an API key provided in the headers. Upon successful deletion, the API returns no content.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a profile form template

  • ID: delete_profile_form_template
  • Operation: write
  • Entities: profile form template, account
  • Summary: This API endpoint allows the user to delete a profile form template for an account. Only templates that were created via the 'Create a profile form template' endpoint can be deleted using this endpoint. The request requires the API key for authentication and the unique identifier of the form template to be deleted as a path parameter. Upon successful deletion, the API returns no content.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Fetch Combined Resumes and Offers for an Opportunity

  • ID: get_all_attachments_for_an_application
  • Operation: read
  • Entities:
  • Summary: The 'Fetch Combined Resumes and Offers for an Opportunity' API endpoint allows users to retrieve all resumes and offers associated with a specific opportunity. The endpoint is accessed via a GET request to the URL 'https://api.lever.co/v1/opportunities/:opportunity', where ':opportunity' is the unique identifier for the opportunity. The request requires an 'Authorization' header with an API key for authentication. Optional query parameters 'uploaded_at_start' and 'uploaded_at_end' can be used to filter resumes by their upload timestamps, and 'expand' can be used to expand the creator ID in the offers response. The response includes a list of attachments, combining both resumes and offers, each with details such as the attachment ID, creation timestamp, file information (name, extension, download URL, upload timestamp, status, and size). This endpoint provides a comprehensive view of all documents related to a given opportunity.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all opportunities

  • ID: get_all_job_applications
  • Operation: read
  • Entities:
  • Summary: The 'List all opportunities' API endpoint retrieves all pipeline opportunities for contacts in your Lever account. It supports various optional query parameters to filter the results, such as 'include', 'expand', 'tag', 'email', 'origin', 'source', 'confidentiality', 'stage_id', 'posting_id', 'archived_posting_id', 'created_at_start', 'created_at_end', 'updated_at_start', 'updated_at_end', 'advanced_at_start', 'advanced_at_end', 'archived_at_start', 'archived_at_end', 'archived', 'archive_reason_id', 'snoozed', and 'contact_id'. The response includes detailed information about each opportunity, such as 'id', 'name', 'headline', 'contact', 'emails', 'phones', 'confidentiality', 'location', 'links', 'createdAt', 'updatedAt', 'lastInteractionAt', 'lastAdvancedAt', 'snoozedUntil', 'archivedAt', 'archiveReason', 'stage', 'stageChanges', 'owner', 'tags', 'sources', 'origin', 'sourcedBy', 'applications', 'resume', 'followers', 'urls', 'dataProtection', and 'isAnonymized'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Download a resume file

  • ID: get_download_a_resume_file
  • Operation: read
  • Entities: opportunity, resume
  • Summary: The 'Download a resume file' API allows users to download a resume file associated with a specific opportunity if it exists. The endpoint requires the opportunity ID and resume ID as path parameters. It uses basic authentication with an API key. The response includes the binary content of the resume file, typically in PDF format, along with headers indicating the content type and disposition. If the file cannot be processed, a 422 Unprocessable Entity status is returned. Note that the endpoint via /candidates/ is deprecated, and users should use the /opportunities/ endpoint instead.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Download a file

  • ID: get_download_file
  • Operation: read
  • Entities: file, opportunity
  • Summary: The 'Download a file' API endpoint allows users to download a file associated with a specific opportunity in Lever. The endpoint requires the opportunity ID and file ID as path parameters, and an API key for authentication in the headers. The response includes the file's binary content and headers indicating the file type and disposition. Note that if the file could not be processed correctly by Lever, a 422 Unprocessable Entity status will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Download Offer File

  • ID: get_download_offer_file
  • Operation: read
  • Entities: file, opportunity, offer
  • Summary: The 'Download Offer File' API allows users to download a specific version of an offer file associated with an opportunity. The endpoint requires the opportunity and offer identifiers as path parameters. An optional query parameter 'status' can be used to specify whether to download the 'sent' or 'signed' version of the offer file. If no status is provided, the most recent document is returned. The API requires an API key for authentication. The response includes a 'downloadUrl' from which the offer file can be downloaded.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve a feedback template

  • ID: get_feedback_template
  • Operation: read
  • Entities: group, field, feedback template
  • Summary: This API retrieves a feedback template for a specific account. The request requires an API key for authentication and the unique identifier of the feedback template as a path parameter. The response includes details about the feedback template such as its ID, name, group information, creation and update timestamps, instructions, stage, and fields with options and prompts.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all archive reasons

  • ID: get_list_all_archive_reasons
  • Operation: read
  • Entities: archive reason
  • Summary: The 'List all archive reasons' API endpoint allows users to retrieve a list of all archive reasons from their Lever account. The endpoint supports filtering by the type of archive reason, which can be either 'hired' or 'non-hired'. The request requires basic authentication using an API key. The response includes a list of archive reasons, each with an ID, text description, status (active or inactive), and type (hired or non-hired).
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all audit events

  • ID: get_list_all_audit_events
  • Operation: read
  • Entities: resource, audit event, user
  • Summary: The 'List all audit events' API retrieves all audit events from your Lever account, sorted in descending chronological order. It supports filtering by event type, user ID, target type, target ID, and creation timestamps. The response includes detailed information about each event, such as the event ID, creation time, type, user details, target details, and additional metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List All Feedback for an Opportunity

  • ID: get_list_all_feedback_for_an_opportunity
  • Operation: read
  • Entities: feedback form, opportunity, candidate
  • Summary: The 'List All Feedback for an Opportunity' API endpoint retrieves all feedback forms associated with a specific opportunity. The endpoint requires an API key for authentication and the unique identifier of the opportunity as a path parameter. The response includes an array of feedback forms, each containing details such as the feedback type, text, instructions, fields, and timestamps for creation, update, completion, and deletion. Each field in the feedback form includes its ID, type, text, description, requirement status, value, prompt, and options if applicable. This API is useful for obtaining comprehensive feedback data for a candidate's opportunity.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all feedback templates

  • ID: get_list_all_feedback_templates
  • Operation: read
  • Entities: group, field, feedback template
  • Summary: The 'List all feedback templates' API endpoint retrieves all active feedback templates for an account, including the default 'no-feedback' template. The endpoint is accessed via a GET request to 'https://api.lever.co/v1/feedback_templates'. The request requires an API key for authentication. The response includes a list of feedback templates, each with details such as the template ID, name, group information, creation and update timestamps, instructions, associated stage, and fields. Each field includes options, prompt, requirement status, text, and type. The response also indicates if there are more templates to fetch with the 'hasNext' boolean.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all files for an opportunity

  • ID: get_list_all_files_for_an_opportunity
  • Operation: read
  • Entities: file, opportunity
  • Summary: The 'List all files for an opportunity' API endpoint allows users to retrieve a list of all files associated with a specific opportunity. The endpoint requires an API key for authentication and the unique identifier of the opportunity as a path parameter. Users can optionally filter the files by their upload timestamp using the 'uploaded_at_start' and 'uploaded_at_end' query parameters. The response includes an array of file objects, each containing details such as the file ID, download URL, extension, name, upload timestamp, processing status, and size.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all interviews for an opportunity

  • ID: get_list_all_interviews_for_an_opportunity
  • Operation: read
  • Entities: opportunity, interview, candidate
  • Summary: The 'List all interviews for an opportunity' API endpoint retrieves all interview events associated with a specific opportunity. The endpoint requires an API key for authentication and the unique identifier of the opportunity as a path parameter. The response includes detailed information about each interview, such as the interview ID, panel, subject, notes, interviewers, timezone, creation date, interview date, duration, location, feedback templates, feedback forms, feedback reminders, user who scheduled the interview, stage, cancellation timestamp, and related postings. This endpoint is useful for obtaining a comprehensive list of interviews for a given opportunity.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all notes on a candidate profile for an Opportunity

  • ID: get_list_all_notes
  • Operation: read
  • Entities: opportunity, note, candidate
  • Summary: The 'List all notes' API endpoint retrieves all notes associated with a specific opportunity. The endpoint is accessed via a GET request to '/opportunities/:opportunity/notes', where ':opportunity' is the unique identifier for the opportunity. The request requires an API key for authentication. The response includes an array of notes, each with details such as the note ID, text, fields, user, and timestamps for creation, completion, and deletion. The 'hasNext' boolean indicates if there are more notes to fetch. Note that the endpoint via '/candidates/' is deprecated.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all offers

  • ID: get_list_all_offers
  • Operation: read
  • Entities: opportunity, offer, candidate
  • Summary: The 'List all offers' API endpoint retrieves all offers associated with a specific opportunity. The endpoint is accessed via a GET request to '/opportunities/:opportunity/offers'. The request requires an API key for authentication, passed in the Authorization header. The 'opportunity' path parameter is mandatory and specifies the unique identifier for the opportunity. An optional query parameter 'expand' can be used to expand the creator ID into a full object in the response. The response includes an array of offer objects, each containing details such as the offer ID, creation timestamp, status, creator ID, and various fields related to the offer. Additionally, information about sent and signed documents is provided, including file names, upload timestamps, and download URLs. The response also indicates if there are more offers to fetch with the 'hasNext' boolean.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all opportunities

  • ID: get_list_all_opportunities
  • Operation: read
  • Entities: contact, opportunity, application
  • Summary: The 'List all opportunities' API endpoint retrieves all pipeline opportunities for contacts in your Lever account. It supports various optional query parameters to filter the results, such as 'include', 'expand', 'tag', 'email', 'origin', 'source', 'confidentiality', 'stage_id', 'posting_id', 'archived_posting_id', 'created_at_start', 'created_at_end', 'updated_at_start', 'updated_at_end', 'advanced_at_start', 'advanced_at_end', 'archived_at_start', 'archived_at_end', 'archived', 'archive_reason_id', 'snoozed', and 'contact_id'. The response includes detailed information about each opportunity, such as 'id', 'name', 'headline', 'contact', 'emails', 'phones', 'confidentiality', 'location', 'links', 'createdAt', 'updatedAt', 'lastInteractionAt', 'lastAdvancedAt', 'snoozedUntil', 'archivedAt', 'archiveReason', 'stage', 'stageChanges', 'owner', 'tags', 'sources', 'origin', 'sourcedBy', 'applications', 'resume', 'followers', 'urls', 'dataProtection', and 'isAnonymized'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all panels for an opportunity

  • ID: get_list_all_panels_for_an_opportunity
  • Operation: read
  • Entities: opportunity, panel, interview
  • Summary: The 'List all panels for an opportunity' API endpoint retrieves all interview panels associated with a specific opportunity. The endpoint requires an API key for authentication and the unique identifier of the opportunity as a path parameter. The response includes details about each panel, such as its ID, associated applications, creation and end timestamps, external management status, and interviews within the panel. Each interview contains information about its ID, date, duration, feedback settings, interviewers, location, and subject. The response also indicates if there are more panels to fetch with the 'hasNext' boolean.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List All Postings in Lever Account

  • ID: get_list_all_postings
  • Operation: read
  • Entities: department, posting, user
  • Summary: This API endpoint lists all postings in your Lever account, including published, internal, closed, draft, pending, and rejected postings. It allows filtering by various parameters such as state, distribution channel, confidentiality, team, department, location, commitment, level, tag, and update timestamps. The response includes detailed information about each posting, such as its ID, title, creation and update timestamps, user, owner, and hiring manager details (which include ID, name, username, email, access role, photo, and other metadata), confidentiality status, categories, content, country, tags, state, distribution channels, requisition codes, salary details, URLs, and workplace type. The API supports optional query parameters to include additional content or expand user IDs into full objects.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all profile form templates

  • ID: get_list_all_profile_form_templates
  • Operation: read
  • Entities: group, field, form template
  • Summary: This API endpoint retrieves all active profile form templates for an account. It includes all form data such as instructions and fields. The response can be customized to include only specific attributes like id, text, and group using the 'include' query parameter. The API requires an API key for authentication. The response contains details about each form template, including its id, creation and update timestamps, text, instructions, group information, whether it is secret by default, and the fields it contains. Each field has its own id, type, text, description, and whether it is required.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all profile forms for a candidate for an Opportunity

  • ID: get_list_all_profile_forms
  • Operation: read
  • Entities: opportunity, form, candidate
  • Summary: This API endpoint retrieves all profile forms associated with a specific opportunity for a candidate. The request requires an API key for authentication and the unique identifier of the opportunity as a path parameter. The response includes details of the form such as its ID, type, text, instructions, base template ID, fields, user, stage, and timestamps for creation, completion, and deletion. Each field in the form has attributes like type, text, description, requirement status, ID, value, and currency if applicable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all referrals for a candidate for an Opportunity

  • ID: get_list_all_referrals
  • Operation: read
  • Entities: opportunity, referral, candidate
  • Summary: The 'List all referrals for a candidate for an Opportunity' API endpoint retrieves all referrals associated with a specific opportunity. The endpoint is accessed via a GET request to '/opportunities/:opportunity/referrals', where ':opportunity' is the unique identifier for the opportunity. The request requires an API key for authentication, provided in the headers. The response includes a list of referral objects, each containing details such as the referral ID, type, text, instructions, fields (including referrer name, relationship, and comments), base template ID, user ID, referrer ID, stage, and timestamps for creation and completion. The response also indicates if there are more referrals to fetch with the 'hasNext' boolean.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all requisition fields

  • ID: get_list_all_requisition_fields
  • Operation: read
  • Entities: subfield, requisition field, requisition
  • Summary: This API endpoint lists all requisition fields in your Lever account. It allows filtering by whether the fields are required and by their top-level type. The request requires basic authentication using an API key. The response includes a list of requisition fields, each with an ID, text description, type, and whether it is required. Each field may also include subfields with their own IDs, text descriptions, and types.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all requisitions

  • ID: get_list_all_requisitions
  • Operation: read
  • Entities: approval, compensation band, requisition
  • Summary: The 'List all requisitions' API endpoint allows users to retrieve a list of requisitions from the Lever platform. Users can filter the requisitions based on various query parameters such as 'created_at_start', 'created_at_end', 'requisition_code', 'status', and 'confidentiality'. The API requires an API key for authentication. The response includes detailed information about each requisition, including its ID, requisition code, name, confidentiality status, creation timestamp, creator ID, headcount details, status, hiring manager, owner, compensation band, employment status, location, internal notes, postings, department, team, offer IDs, approval details, custom fields, and timestamps for closure and updates.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all resumes for an opportunity

  • ID: get_list_all_resumes_for_an_opportunity
  • Operation: read
  • Entities: opportunity, resume, candidate
  • Summary: The 'List all resumes for an opportunity' API endpoint allows users to retrieve all resumes associated with a specific opportunity. The endpoint is accessed via a GET request to the URL 'https://api.lever.co/v1/opportunities/:opportunity/resumes', where ':opportunity' is the unique identifier for the opportunity. The request requires an 'Authorization' header with a Basic authentication API key. Optional query parameters 'uploaded_at_start' and 'uploaded_at_end' can be used to filter resumes by their upload timestamps. The response includes a list of resumes, each with details such as the resume ID, creation timestamp, file information (name, extension, download URL, upload timestamp, status, and size), and parsed data including positions and educational background. The endpoint is designed to provide comprehensive resume data for a given opportunity.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all sources

  • ID: get_list_all_sources
  • Operation: read
  • Entities: source, account
  • Summary: The 'List all sources' API endpoint retrieves a list of all sources in your Lever account. It requires a GET request to the URL 'https://api.lever.co/v1/sources' with basic authentication using an API key. The response includes a JSON object with a 'data' array, where each element contains a 'text' field representing the name of the source and a 'count' field indicating the number of occurrences of that source.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all stages

  • ID: get_list_all_stages
  • Operation: read
  • Entities: pipeline, account, stage
  • Summary: The 'List all stages' API retrieves all pipeline stages available in your Lever account. It requires a GET request to the endpoint 'https://api.lever.co/v1/stages' with basic authentication using an API key. The response includes an array of stages, each with a unique 'id' and a 'text' field representing the name of the stage. This API does not require any path or query parameters, nor does it require a request body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all tags

  • ID: get_list_all_tags
  • Operation: read
  • Entities: tag, API key, account
  • Summary: The 'List all tags' API endpoint allows users to retrieve all tags associated with their Lever account. The request requires an API key for authentication, which should be included in the headers. The response returns a list of tags, each with a 'text' field indicating the tag name and a 'count' field indicating the number of times the tag is used.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all users

  • ID: get_list_all_users
  • Operation: read
  • Entities: user
  • Summary: The 'List all users' API retrieves a list of all active users in your Lever account. By default, only active users are included, but you can include deactivated users by setting the 'includeDeactivated' query parameter to true. You can filter the results by email, access role, or external directory ID using the respective query parameters. The response includes detailed information about each user, such as their ID, name, email, access role, job title, and more.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Deleted Opportunities

  • ID: get_list_deleted_opportunities
  • Operation: read
  • Entities: opportunity
  • Summary: The 'List Deleted Opportunities' API endpoint allows users to retrieve a list of all deleted opportunities from their Lever account. The endpoint supports filtering by the timestamp of deletion using the optional query parameters 'deleted_at_start' and 'deleted_at_end'. If 'deleted_at_start' is provided, the API returns opportunities deleted from that timestamp onwards. If 'deleted_at_end' is provided, it returns opportunities deleted up to that timestamp. The response includes an array of deleted opportunities, each with a unique 'opportunity_id' and the 'deleted_at' timestamp.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Webhooks

  • ID: get_list_webhooks
  • Operation: read
  • Entities: event, configuration, webhook
  • Summary: The List Webhooks API retrieves all existing webhooks configured in the system. It requires an API key for authentication, which should be included in the request headers. The response includes a list of webhooks, each with details such as the webhook ID, URL, event type, creation and update timestamps, and configuration conditions. This API is useful for managing and reviewing webhook configurations.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve a Profile Form Template

  • ID: get_profile_form_template
  • Operation: read
  • Entities: group, field, profile form template
  • Summary: The Retrieve a Profile Form Template API endpoint allows users to fetch a single profile form template by its unique identifier. This endpoint is useful for obtaining a reference template when creating a new profile form. The request requires an API key for authentication and the form template ID as a path parameter. The response includes details such as the template's creation and update timestamps, text description, instructions, group information, and fields with their respective types, descriptions, and requirement status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve a diversity survey

  • ID: get_retrieve_a_diversity_survey
  • Operation: read
  • Entities: location, country code, survey
  • Summary: The 'Retrieve a diversity survey' API endpoint allows users to retrieve a diversity survey associated with a specific location. The endpoint requires a posting ID as a path parameter and optionally accepts a country code as a query parameter to filter candidate self-select location surveys. If no country code is provided and the account's survey type is set to candidate self-select, all active surveys will be returned. The response includes details such as survey ID, creation and update timestamps, survey text, candidate locations, instructions, and fields with options.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve a Feedback Form

  • ID: get_retrieve_a_feedback_form
  • Operation: read
  • Entities: opportunity, interview, feedback
  • Summary: The Retrieve a Feedback Form API endpoint allows users to retrieve detailed information about a specific feedback form associated with an opportunity. The endpoint requires the opportunity ID and feedback ID as path parameters. The response includes the feedback form's ID, type, text, instructions, and various fields with their respective details such as type, text, description, required status, value, prompt, and options. Additionally, metadata such as baseTemplateId, interview ID, panel ID, user ID, and timestamps for creation, update, completion, and deletion are provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve a Profile Form

  • ID: get_retrieve_a_profile_form
  • Operation: read
  • Entities: opportunity, field, form
  • Summary: The Retrieve a Profile Form API endpoint allows you to retrieve a specific profile form associated with an opportunity. The endpoint requires the opportunity ID and form ID as path parameters. The response includes detailed information about the form, such as its ID, type, text, instructions, base template ID, fields, user ID, stage ID, and timestamps for when the form was completed, created, and deleted. The fields array contains various types of fields, each with its own properties like type, text, description, required status, ID, value, and currency if applicable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve a Single Contact

  • ID: get_retrieve_a_single_contact
  • Operation: read
  • Entities: contact, phone, location
  • Summary: The 'Retrieve a Single Contact' API endpoint allows users to fetch details of a specific contact using their unique identifier. The request requires an API key for authentication, which should be included in the headers. The contact ID is specified as a path parameter. The response includes detailed information about the contact, such as their name, headline, location, email addresses, and phone numbers.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve a Single File

  • ID: get_retrieve_a_single_file
  • Operation: read
  • Entities: file, opportunity, candidate
  • Summary: The Retrieve a Single File API endpoint allows users to retrieve metadata for a specific file associated with an opportunity. The endpoint requires the opportunity ID and file ID as path parameters and uses an API key for authentication. The response includes details such as the file ID, download URL, file extension, name, upload timestamp, status, and size. Note that the endpoint via /candidates/ is deprecated, and users should use the /opportunities/ endpoint for the same response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve a Single Note

  • ID: get_retrieve_a_single_note
  • Operation: read
  • Entities: opportunity, user, note
  • Summary: The Retrieve a Single Note API endpoint allows users to fetch a specific note associated with an opportunity using the opportunity and note identifiers. The request requires an API key for authentication and the unique identifiers for both the opportunity and the note as path parameters. The response includes detailed information about the note, such as its text content, associated fields, user information, and timestamps for creation, completion, and deletion. This endpoint is part of the Lever API and is used to access notes related to opportunities.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve a Single Opportunity

  • ID: get_retrieve_a_single_opportunity
  • Operation: read
  • Entities: opportunity, stage, application
  • Summary: The 'Retrieve a Single Opportunity' API endpoint allows users to fetch detailed information about a specific opportunity using its unique identifier. The request requires basic authentication using an API key and the opportunity ID as a path parameter. The response includes comprehensive details about the opportunity, such as contact information, confidentiality status, location, associated tags, sources, and data protection settings. It also provides timestamps for creation, updates, interactions, and stage changes, along with URLs for candidate lists and specific candidate views.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve a Single Panel

  • ID: get_retrieve_a_single_panel
  • Operation: read
  • Entities: opportunity, panel, interview
  • Summary: The 'Retrieve a Single Panel' API endpoint allows users to fetch details of a specific panel associated with an opportunity. The endpoint requires the opportunity ID and panel ID as path parameters. The response includes detailed information about the panel, such as its ID, associated applications, creation and end timestamps, external management status, external URL, interviews, notes, stage, start time, timezone, and user ID. The interviews array provides details about each interview, including interviewers, location, and subject.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve a Single Stage

  • ID: get_retrieve_a_single_stage
  • Operation: read
  • Entities: stage
  • Summary: The 'Retrieve a Single Stage' API endpoint allows users to fetch details of a specific stage using its unique identifier. The request requires an API key for authentication, which should be included in the headers. The stage ID is a path parameter that specifies which stage to retrieve. The response includes the stage's unique identifier and its name or description.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve anonymous EEO responses

  • ID: get_retrieve_anonymous_eeo_responses
  • Operation: read
  • Entities: stage, EEO response, application
  • Summary: The 'Retrieve anonymous EEO responses' API endpoint allows users to list anonymous Equal Employment Opportunity (EEO) responses. The API requires an API key for authentication and supports optional query parameters 'fromDate' and 'toDate' to filter the responses by date range. The response includes details such as application timestamps, current stage, gender, race, veteran status, and disability information of the applicants.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve EEO responses with PII

  • ID: get_retrieve_eeo_responses_with_pii
  • Operation: read
  • Entities: user, EEO response, application
  • Summary: This API endpoint retrieves EEO (Equal Employment Opportunity) responses with Personally Identifiable Information (PII) from the Lever platform. It supports optional query parameters such as 'expand' to expand user IDs and posting ID into full objects, 'created_at_start' to specify the start date for retrieving data, and 'created_at_end' to specify the end date. The response includes detailed information about each EEO response, such as application dates, current stage, contact information, gender, race, veteran status, disability status, and more.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Posting Application Questions

  • ID: get_retrieve_posting_application_questions
  • Operation: read
  • Entities: question, posting, application
  • Summary: The Retrieve Posting Application Questions API endpoint provides a list of questions included in a job posting's application form. It indicates whether each field is required. The API is accessed via a GET request to the specified URL with the posting ID as a path parameter. The request requires an API key for authentication. The response includes custom questions, EEO questions, personal information fields, and URLs related to the application. Custom questions may include fields like previous work experience and favorite programming language. EEO questions cover topics such as gender, race, veteran status, and disability, with options for each. Personal information fields include full name, email, current company, phone, resume, and additional information. URLs may include LinkedIn, other websites, and GitHub profiles. Note that collecting disability information is only allowed for US contractors, and EEO questions may not be saved if legally restricted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve a Single Archive Reason

  • ID: get_single_archive_reason
  • Operation: read
  • Entities: archive reason
  • Summary: The 'Retrieve a Single Archive Reason' API endpoint allows users to fetch details of a specific archive reason by its unique identifier. The request requires an API key for authentication and the archive reason ID as a path parameter. The response includes the archive reason's ID, description, status, and type.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve a Single Interview

  • ID: get_single_interview
  • Operation: read
  • Entities: opportunity, user, interview
  • Summary: The 'Retrieve a Single Interview' API endpoint allows users to fetch details of a specific interview associated with a given opportunity. The endpoint requires the opportunity ID and interview ID as path parameters. The response includes detailed information about the interview such as the panel ID, subject, notes, interviewers, timezone, creation date, scheduled date, duration, location, feedback templates, feedback forms, feedback reminder settings, user ID, stage ID, cancellation status, and associated postings. This endpoint is authenticated using an API key.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve a Single Posting

  • ID: get_single_posting
  • Operation: read
  • Entities: job description, posting, distribution channel
  • Summary: The 'Retrieve a Single Posting' API endpoint allows users to fetch the details of a specific job posting, including the job description and associated metadata. The endpoint requires the unique posting ID as a path parameter and optionally accepts a 'distribution' query parameter to specify whether to return internal or external custom application questions. The response includes detailed information about the job posting, such as its title, creation and update timestamps, user and owner details, confidentiality level, categories like team and department, job content including descriptions and lists, location, state, distribution channels, requisition codes, salary details, and URLs for listing, viewing, and applying for the job. The API is authenticated using an API key.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve a Single Referral

  • ID: get_single_referral
  • Operation: read
  • Entities: opportunity, referral, user
  • Summary: The 'Retrieve a Single Referral' API endpoint allows users to fetch details of a specific referral associated with a given opportunity. The endpoint requires the opportunity ID and referral ID as path parameters. The response includes detailed information about the referral, such as the referral ID, type, text, instructions, fields (including referrer name, relationship, and comments), base template ID, user ID, referrer ID, stage ID, and timestamps for creation and completion. This endpoint is authenticated using an API key.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve a Single Requisition

  • ID: get_single_requisition
  • Operation: read
  • Entities: Requisition, Approval, Custom Field
  • Summary: The 'Retrieve a Single Requisition' API endpoint allows users to fetch detailed information about a specific requisition using its unique identifier. The API requires an API key for authentication and the requisition ID as a path parameter. The response includes comprehensive details about the requisition such as its code, name, status, headcount, compensation band, location, department, and more. It also provides information about the approval process, custom fields, and timestamps related to the requisition's lifecycle.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve a Single Requisition Field

  • ID: get_single_requisition_field
  • Operation: read
  • Entities: field, requisition
  • Summary: The 'Retrieve a Single Requisition Field' API endpoint allows users to retrieve details of a specific requisition field by its ID. The request requires an API key for authentication and the ID of the requisition field as a path parameter. The response includes the ID, display text, type, and whether the field is required, along with any subfields associated with the requisition field.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve a Single Resume

  • ID: get_single_resume
  • Operation: read
  • Entities: opportunity, parsed data, resume
  • Summary: The 'Retrieve a Single Resume' API endpoint allows users to retrieve metadata for a specific resume associated with an opportunity. The endpoint requires the opportunity ID and resume ID as path parameters. The response includes details such as the resume's creation timestamp, file information (name, extension, download URL, upload timestamp, status, and size), and parsed data including positions and educational background. This endpoint is accessed via a GET request and requires an API key for authentication. Note that the endpoint via /candidates/ is deprecated, and users should use the /opportunities/ endpoint for the same response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve a Single User

  • ID: get_single_user
  • Operation: read
  • Entities: User
  • Summary: The 'Retrieve a Single User' API endpoint allows you to fetch the full user record for a specific user by their user ID. The request requires an API key for authentication, which should be included in the Authorization header. The user ID is specified as a path parameter in the URL. The response includes detailed information about the user, such as their ID, name, username, email, creation and deactivation timestamps, external directory ID, access role, photo URL, linked contact IDs, job title, and manager ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Apply to a Posting

  • ID: post_apply_to_a_posting
  • Operation: write
  • Entities: application, candidate, posting
  • Summary: The 'Apply to a Posting' API endpoint allows you to submit an application on behalf of a candidate to a specific job posting. This endpoint is used for submitting applications to postings that are either published or unlisted. The request must be in JSON format and include various fields such as custom questions, personal information, EEO responses, URLs, and optionally, diversity survey information. The endpoint also supports sending a confirmation email to the candidate if specified in the query parameters. The response includes the application ID of the newly created application.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Panel

  • ID: post_create_a_panel
  • Operation: write
  • Entities: interview, opportunity, panel
  • Summary: The 'Create a Panel' API endpoint allows users to create a panel and associate it with a specific opportunity. The endpoint requires the opportunity ID as a path parameter and the 'perform_as' user ID as a query parameter. The request body must include the timezone and a non-empty array of interview objects. Optional fields include applications, feedback reminders, notes, and an external URL. The response returns details of the created panel, including its ID, associated applications, interviews, and other metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Posting

  • ID: post_create_a_posting
  • Operation: write
  • Entities: user, category, posting
  • Summary: The 'Create a Posting' API endpoint allows integrations to create job postings in a Lever account. This API does not trigger the approvals chain, but postings can be created as drafts and later go through approvals within Lever Hire. The API accepts requests in JSON format and requires a 'perform_as' query parameter to specify the user on whose behalf the posting is created. The request body includes details such as the job title, state, distribution channels, owner, hiring manager, categories, tags, content, workplace type, and requisition codes. The response returns the created posting's details, including its ID, title, timestamps, user information, categories, content, distribution channels, salary details, state, tags, URLs, workplace type, and requisition codes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a requisition

  • ID: post_create_a_requisition
  • Operation: write
  • Entities: custom field, compensation band, requisition
  • Summary: The 'Create a requisition' API allows users to create a new requisition in Lever by sending a POST request to the /requisitions endpoint. The request must include a JSON body with required fields such as 'requisitionCode', 'name', and 'headcountTotal'. Optional fields include 'backfill', 'compensationBand', 'createdAt', 'customFields', 'employmentStatus', 'hiringManager', 'internalNotes', 'location', 'owner', 'status', 'team', and 'postingIds'. The API returns a 201 status code upon successful creation, along with the newly created requisition data, including a unique Lever ID. This API is useful for integrating HRIS systems with Lever to manage requisition data efficiently.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Webhook

  • ID: post_create_a_webhook
  • Operation: write
  • Entities: event, webhook, candidate
  • Summary: The 'Create a Webhook' API allows users to create a new webhook by specifying the webhook URL and event type. The API requires the 'url' and 'event' parameters, while 'configuration', 'conditions', and 'verifyConnection' are optional. Upon successful creation, the API returns a response containing the webhook's unique ID, event type, URL, configuration details including a signature token, and timestamps for creation and last update. A Super Admin must enable the webhook group in account settings for data transmission to commence.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create an Interview

  • ID: post_create_an_interview
  • Operation: write
  • Entities: interviewer, panel, interview
  • Summary: The 'Create an Interview' API endpoint allows users to create a new interview on an existing panel object. This endpoint is used to add interviews to panels where 'externallyManaged' is true. The API requires the opportunity ID as a path parameter and the 'perform_as' user ID as a query parameter. The request body must include the panel UID, date, duration, and at least one interviewer. Optional fields include subject, note, location, feedback template, and feedback reminder. The response returns the details of the created interview, including the interview ID, panel, subject, note, interviewers, timezone, creation timestamp, scheduled date, duration, location, feedback template, feedback forms, feedback reminder, user, stage, and related postings.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create an opportunity

  • ID: post_create_an_opportunity
  • Operation: write
  • Entities:
  • Summary: The 'Create an opportunity' API endpoint allows integrations to create candidates and opportunities in a Lever account. It supports both JSON and multipart/form-data requests, enabling the inclusion of candidate information and resume files. The API deduplicates candidates based on email and links new opportunities to existing contacts if a match is found. It accepts various parameters such as perform_as, parse, and perform_as_posting_owner, and fields like name, headline, stage, location, phones, emails, links, tags, sources, origin, owner, followers, resumeFile, files, postings, createdAt, archived, and contact. The response includes the opportunity ID, status, and a message indicating the result of the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Feedback Form for an Opportunity

  • ID: post_create_feedback_form
  • Operation: write
  • Entities: feedback form, interview, opportunity
  • Summary: This API endpoint allows the creation of a feedback form for a specific opportunity. The request requires the opportunity ID as a path parameter and the user ID to perform the action on behalf of as a query parameter. The request body must include the base template ID and can optionally include panel and interview IDs, field values, and timestamps for creation and completion. The response returns the details of the created feedback form, including its fields, associated panel and interview, and timestamps.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Feedback Template

  • ID: post_create_feedback_template
  • Operation: write
  • Entities: field, group, feedback template
  • Summary: This API endpoint allows the creation of a feedback template for an account. The request must include the name of the feedback template, instructions, the group UID, and an array of fields. Each field can have various types such as date, currency, multiple-select, and score-system, among others. The fields array must include at least one field of type score-system. The response returns the created feedback template with its unique ID, name, instructions, group details, fields, and timestamps for creation and last update.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Note on Candidate Profile

  • ID: post_create_note_on_candidate_profile
  • Operation: write
  • Entities: user, note, candidate
  • Summary: The 'Create a Note on Candidate Profile' API allows users to create a note and add it to a candidate's profile under a specific opportunity. Users can @-mention other users in the note's body to trigger notifications. The API supports optional parameters such as performing the action on behalf of another user, adding comments to existing notes, setting the note's visibility, scoring the note, notifying followers, and setting a historical creation date. The response includes the unique identifier of the created note.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Profile Form

  • ID: post_create_profile_form
  • Operation: write
  • Entities: opportunity, profile form, candidate
  • Summary: The Create a Profile Form API allows you to create a completed profile form and add it to a candidate profile for an Opportunity. The form must be based on an existing profile form template identified by 'baseTemplateId'. The API requires a POST request to the endpoint '/opportunities/:opportunity/forms'. You can specify a user to perform the action on behalf of using the 'perform_as' query parameter. The request body must include 'baseTemplateId', an array of 'fields' conforming to the template, and an optional 'secret' flag. The response includes details of the created profile form, including its ID, creation timestamp, and fields.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Profile Form Template

  • ID: post_create_profile_form_template
  • Operation: write
  • Entities: profile, form, template
  • Summary: This API creates a profile form template for an account. It requires a POST request to the /form_templates endpoint with a JSON body containing the form template details such as 'text' for the name of the form, 'instructions' for form instructions, 'secretByDefault' to indicate if the form is secret by default, 'group' for the group UID, and 'fields' which is an array of form fields. Each field in the 'fields' array must specify its 'type', 'text', 'description', and whether it is 'required'. The response includes the unique identifier for the form template, creation timestamp, and details of the form template including its fields.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a requisition field

  • ID: post_create_requisition_field
  • Operation: write
  • Entities: option, field, requisition
  • Summary: The 'Create a requisition field' API allows users to create a set of requisition field schemas that can be used across their account for any requisition. The API accepts POST requests with a JSON body containing the field identifier, human-readable field name, field type, and optionally, whether the field is required. Fields can be of type 'number', 'text', 'date', 'object', or 'dropdown'. For 'object' type fields, subfields must be specified, and for 'dropdown' type fields, options must be provided. The response includes the created field's details, including its identifier, name, type, and any subfields or options.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a user

  • ID: post_create_user
  • Operation: write
  • Entities: user
  • Summary: This API endpoint allows integrations to create a user in the Lever account with a default role of Interviewer. Users can also be created with roles such as Limited Team Member, Team Member, Admin, or Super Admin. The request must be of type application/json and include the user's name and email as required fields. Optional fields include accessRole, externalDirectoryId, jobTitle, and managerId. The response includes the user's ID, name, username, email, timestamps for creation and deactivation, external directory ID, access role, photo URL, linked contact IDs, job title, and manager ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Deactivate a user

  • ID: post_deactivate_user
  • Operation: write
  • Entities: user
  • Summary: The 'Deactivate a user' API allows you to deactivate a user in the Lever system. Deactivated users remain in the system for historical record keeping but can no longer log in and use Lever. The API requires a POST request to the endpoint '/users/:user/deactivate' with the user's unique identifier in the path parameter. The request must include the 'Content-Type' header set to 'application/json' and an 'Authorization' header with the API key. The response includes details of the deactivated user such as their ID, name, username, email, creation and deactivation timestamps, external directory ID, access role, photo URL, linked contact IDs, job title, and manager ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Reactivate a User

  • ID: post_reactivate_user
  • Operation: write
  • Entities: user
  • Summary: The Reactivate a User API allows you to reactivate a user that has been previously deactivated. The endpoint requires a POST request to '/users/:user/reactivate' with the user's unique identifier in the path parameters. The request must include headers for 'Content-Type' as 'application/json' and 'Authorization' with a valid API key. The response returns the user's details including id, name, username, email, creation timestamp, and other relevant information. The 'deactivatedAt' field will be null indicating the user is active.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Posting

  • ID: post_update_a_posting
  • Operation: write
  • Entities: user, posting, job
  • Summary: The 'Update a Posting' API endpoint allows users to partially update job postings in their Lever account. This endpoint uses the POST method and requires the posting ID as a path parameter and the 'perform_as' query parameter to specify the user on whose behalf the update is performed. The request body can include various fields such as 'text' for the job title, 'state' for the posting status, 'distributionChannels' for job sites, 'categories' for team, department, location, and commitment tags, 'tags' for additional posting tags, 'content' for job description and lists, 'workplaceType' for the type of workplace, and 'requisitionCodes' for associated requisition codes. The response includes the updated posting details such as 'id', 'text', 'createdAt', 'updatedAt', 'user', 'owner', 'hiringManager', 'categories', 'content', 'distributionChannels', 'salaryDescription', 'salaryRange', 'state', 'tags', 'urls', 'workplaceType', and 'requisitionCodes'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Contact Links by Opportunity

  • ID: post_update_contact_links_by_opportunity
  • Operation: write
  • Entities: contact, opportunity, link
  • Summary: The 'Update Contact Links by Opportunity' API allows users to add or remove links associated with a contact through a specified opportunity. The API requires the opportunity ID as a path parameter and accepts an optional 'perform_as' parameter to perform the update on behalf of a specified user. The body of the request must include an array of links to be added or removed. The response includes a status and a message indicating the result of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Opportunity Sources

  • ID: post_update_opportunity_sources
  • Operation: write
  • Entities: opportunity, user, source
  • Summary: The 'Update Opportunity Sources' API allows users to add or remove sources from a specified opportunity. The API requires the opportunity ID as a path parameter and an array of sources in the request body. Optionally, the request can include a 'perform_as' header to specify the user on whose behalf the operation is performed. The response indicates whether the operation was successful and provides a descriptive message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Opportunity Tags

  • ID: post_update_opportunity_tags
  • Operation: write
  • Entities: tag, opportunity, user
  • Summary: The Update Opportunity Tags API allows users to add or remove tags from a specified opportunity. The API requires the opportunity ID as a path parameter. Users can optionally specify a 'perform_as' parameter to perform the update on behalf of another user. The request body must include an array of tags to be added or removed. The response indicates whether the operation was successful and provides a message detailing the result.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updating Dropdown Fields

  • ID: post_updating_dropdown_fields
  • Operation: write
  • Entities: option, requisition field
  • Summary: The 'Updating Dropdown Fields' API allows users to append, update, or delete options in a dropdown field without needing to replace the entire object. The API supports POST, PUT, and DELETE methods. The POST method is used to add new options to the dropdown. The request requires a 'Content-Type' header set to 'application/json' and an 'Authorization' header with the API key. The path parameter ':requisition_field' specifies the dropdown field to be updated. The request body contains an array of 'values', each with a 'text' property representing the dropdown option. The response returns the 'id' and 'text' of the newly created option.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Upload a file

  • ID: post_upload_a_file
  • Operation: write
  • Entities: file, application
  • Summary: The 'Upload a file' API endpoint allows users to upload files temporarily to be used in conjunction with the 'Apply to a posting' endpoint. This endpoint accepts requests of type 'multipart/form-data' and allows uploading of binary files up to 30MB in size. The uploaded file will be available for 24 hours, after which it cannot be referenced. The response includes details such as the expiration timestamp, filename, unique file ID, URI for accessing the file, and the file size.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Upload a Single File

  • ID: post_upload_a_single_file
  • Operation: write
  • Entities: file, opportunity, user
  • Summary: The 'Upload a Single File' API endpoint allows users to upload a file to a specified opportunity. The request must be made using the POST method to the '/opportunities/:opportunity/files' URL, where ':opportunity' is the ID of the opportunity. The request must include a 'perform_as' query parameter to specify the user on whose behalf the upload is performed. The file must be included in the request body as a binary file with a maximum size of 30MB, and the request must be of type 'multipart/form-data'. Upon successful upload, the API returns a response containing details of the uploaded file, including its ID, download URL, extension, name, upload timestamp, status, and size. In case of an error, such as a timeout, an error response with a code and message is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a contact

  • ID: put_update_a_contact
  • Operation: write
  • Entities: contact, phone, email
  • Summary: The 'Update a contact' API allows users to update the details of an existing contact in the system. The API requires the contact's unique identifier in the path parameter and accepts optional fields in the request body such as name, headline, location, emails, and phones. The request must include headers for content type and authorization. The response returns the updated contact details including the contact's ID, name, headline, anonymization status, location, emails, and phones.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Feedback Template

  • ID: put_update_a_feedback_template
  • Operation: write
  • Entities: group, field, feedback template
  • Summary: This API updates a feedback template for an account. It requires the feedback template ID as a path parameter and accepts a JSON body containing the name, instructions, group UID, and an array of form fields. The fields array must include at least one field of type 'score-system'. The API returns the updated feedback template details, including its ID, name, instructions, group information, fields, and timestamps for creation and last update.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a note

  • ID: put_update_a_note
  • Operation: write
  • Entities: opportunity, user, note
  • Summary: The 'Update a note' API allows users to update an existing note associated with an opportunity. This is an atomic operation, meaning the entire note object is replaced with the specified values. The API requires the opportunity ID and note ID as path parameters. The request body must include an array of comments in the 'values' field, where each comment has a 'value' and optionally a 'createdAt' timestamp. Additional optional fields include 'user' (the UID of the user who began the note thread), 'secret' (a boolean indicating if the note is secret), 'createdAt' and 'completedAt' timestamps, and a 'score' between 1 and 4. The response returns the ID of the updated note.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Panel

  • ID: put_update_a_panel
  • Operation: write
  • Entities: panel, user, interview
  • Summary: The 'Update a Panel' API endpoint allows users to update an existing panel associated with a specific opportunity. This endpoint requires the entire panel object to be present in the PUT request, as missing fields will be deleted. Only panels with 'externallyManaged' set to true can be updated via this API. The request must include the opportunity and panel IDs as path parameters, and a 'perform_as' query parameter to specify the user on whose behalf the update is performed. The request body should contain details such as applications, timezone, feedback reminder, note, external URL, and interviews. The response returns the updated panel details, including applications, interviews, and other metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a requisition

  • ID: put_update_a_requisition
  • Operation: write
  • Entities: custom field, compensation band, requisition
  • Summary: The 'Update a requisition' API allows you to update an existing requisition in Lever. When using this API, you must provide the entire resource as the body of the PUT request, as all fields will be overwritten. If a field is not included, it will be deleted or reset to its default. The API requires a requisition ID as a path parameter and expects a JSON body with details such as requisitionCode, name, createdAt, headcountTotal, status, hiringManager, compensationBand, employmentStatus, location, team, postingIds, and customFields. The response includes the updated requisition data with fields like id, requisitionCode, name, postingIds, backfill, createdAt, creator, headcountHired, headcountTotal, status, hiringManager, approval, compensationBand, employmentStatus, location, team, offerIds, customFields, closedAt, timeToFillStartAt, timeToFillEndAt, and updatedAt.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Webhook

  • ID: put_update_a_webhook
  • Operation: write
  • Entities: configuration, condition, webhook
  • Summary: The 'Update a Webhook' API allows users to update one or more webhooks that were previously created via the API. The endpoint for this operation is PUT /webhooks/. The request requires a JSON body containing an array of objects, each representing a webhook to be updated. Each object must include the 'id' of the webhook, and may optionally include a new 'url', 'configuration', and 'verifyConnection' flag. The 'configuration' object can specify conditions under which the webhook is applicable. The response returns an array of updated webhook objects, each containing details such as 'id', 'url', 'event', 'createdAt', 'updatedAt', and 'configuration'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update an Interview

  • ID: put_update_an_interview
  • Operation: write
  • Entities: interviewer, panel, interview
  • Summary: The 'Update an Interview' API endpoint allows users to update an existing interview associated with a specific opportunity. This endpoint requires the entire interview object to be present in the PUT request, as missing fields will be deleted. It is important to note that this endpoint cannot be used to update interviews created within the Lever application; only interviews within panels where 'externallyManaged' is true can be updated. The request must include the 'perform_as' query parameter to specify the user on whose behalf the update is performed. The request body should contain details such as the panel ID, subject, note, interviewers, date, duration, location, feedback template, and feedback reminder. The response includes the updated interview details, including the interview ID, panel, subject, note, interviewers, timezone, creation date, duration, location, feedback template, feedback forms, feedback reminder, user, stage, and postings.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Feedback

  • ID: put_update_feedback
  • Operation: write
  • Entities: opportunity, field, feedback
  • Summary: The Update Feedback API allows you to update a feedback form for a specific opportunity. The endpoint requires the opportunity ID and feedback ID as path parameters. You can perform the update on behalf of a specified user by providing the 'perform_as' query parameter. The request body can include a 'completedAt' timestamp and an array of 'fieldValues' to update specific fields in the feedback form. The response includes detailed information about the updated feedback, including account ID, user ID, profile ID, and the fields with their respective values and options.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Opportunity Archived State

  • ID: put_update_opportunity_archived_state
  • Operation: write
  • Entities: opportunity, requisition, offer
  • Summary: This API updates the archived state of an Opportunity. If the Opportunity is already archived, the archive reason can be changed, or it can be unarchived by specifying null as the reason. If the Opportunity is active, it will be archived with the provided reason. The API accepts an optional 'perform_as' header to perform the update on behalf of a specified user. The request body requires a 'reason' for archiving, and optionally accepts 'cleanInterviews' to remove pending interviews and 'requisitionId' to hire a candidate against a specific requisition. The response includes the status of the operation, a message, and details of the updated opportunity.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Opportunity Stage

  • ID: put_update_opportunity_stage
  • Operation: write
  • Entities: opportunity, user, stage
  • Summary: The 'Update Opportunity Stage' API allows users to change the current stage of a specified opportunity. The endpoint requires the opportunity's unique identifier as a path parameter. Optionally, the update can be performed on behalf of another user by providing their identifier in the 'perform_as' query parameter. The request body must include the new stage ID for the opportunity. The response indicates whether the update was successful and provides a message with additional information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a profile form template

  • ID: put_update_profile_form_template
  • Operation: write
  • Entities: group, field, form template
  • Summary: This API updates a profile form template for an account. It requires the form template ID as a path parameter and accepts a JSON body with details such as the name of the form template, instructions, whether the form is secret by default, the group UID, and an array of fields. Each field must specify its type, text, description, and whether it is required. The API returns the updated form template details, including its ID, creation and update timestamps, and the fields with their respective IDs.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a requisition field

  • ID: put_update_requisition_field
  • Operation: write
  • Entities: requisition field, requisition
  • Summary: The 'Update a requisition field' API allows users to update an existing requisition field by sending a PUT request to the specified endpoint. The request must include the full requisition_field object with updated properties in the request body. Any properties not included will be considered deleted. The API requires a Content-Type header set to 'application/json' and an API key for authentication. The response returns the updated requisition field data.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a User

  • ID: put_update_user
  • Operation: write
  • Entities: user
  • Summary: The 'Update a User' API allows you to update the details of an existing user in the system. This API requires a PUT request to the endpoint '/users/:user', where ':user' is the unique identifier of the user to be updated. The request must include the 'Content-Type' header set to 'application/json'. The body of the request must contain the user's 'name', 'email', and 'accessRole', which are required fields. Optionally, you can include 'externalDirectoryId'. If any field is omitted, it will be deleted or reset to its default value. The response includes the updated user details such as 'id', 'name', 'username', 'email', 'createdAt', 'deactivatedAt', 'externalDirectoryId', 'accessRole', 'photo', 'linkedContactIds', 'jobTitle', and 'managerId'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated about 1 month ago