Lever
App · 27 actions
Manage recruiting opportunities, stages, notes and tags; read contacts, interviews, offers and job postings in Lever.
Actions
| Action | What it does |
|---|---|
| Add opportunity tags | Add one or more tags to an opportunity. |
| Archive opportunity | Archive an opportunity with an archive reason (such as hired, withdrew or not a fit, as set up in your Lever account), which takes the candidate out of the active pipeline. |
| Change opportunity stage | Move an opportunity (a candidate) to another stage of the hiring pipeline, picked by name or given as a stage id from List stages. |
| Create note | Add a note to an opportunity's profile in Lever. |
| Create opportunity | Add a candidate to Lever as a new opportunity, optionally against a posting, in a stage and with an owner. |
| Get contact | Get a contact, the person behind one or more opportunities: name, headline, location, emails and phone numbers. |
| Get interview | Get one interview on an opportunity by the interview's id: subject, date (epoch milliseconds), length in minutes, location, the interviewers' names and emails, and when it was cancelled if it was. |
| Get note | Get one note on an opportunity by the note's id: its text, the id of the user who wrote it, whether it is secret and when it was written (epoch milliseconds). |
| Get opportunity | Get one opportunity (one person's candidacy for a job) by its id: the candidate's name, emails and headline, the stage it is in, its owner (the Lever user responsible for it, usually the recruiter), tags, sources and a link that opens it in Lever. |
| Get posting | Get one job posting by its id: its title (returned as text), state, team, department, location, description, the user ids of its owner and hiring manager, and its links. |
| Get stage | Get one pipeline stage's name (returned as text) from its id, such as the stage id on an opportunity. |
| Get user | Get one Lever user by id: name, email, job title and access role. |
| List archive reasons | List the reasons an opportunity can be archived with in this account, as an id and a name (returned as text). |
| List candidates waiting in a stage | (beta) List the active candidates who have been in their current pipeline stage for more than a number of days, with their name and email, the stage, how many days they have waited, the job they applied to, a link to them in Lever, and their owner (usually the recruiter). |
| List feedback | List the interview feedback forms filled in for an opportunity, one page of up to 100 at a time, each with its questions and the answers given. |
| List interviews | List the interviews scheduled for an opportunity, one page of up to 100 at a time: subject, date (epoch milliseconds), length in minutes, location, the interviewers' names and emails, and when it was cancelled if it was. |
| List interviews on a day | Beta. |
| List notes | List the notes on an opportunity, one page of up to 100 at a time: each note's text, the id of the user who wrote it, whether it is secret and when it was written (epoch milliseconds). |
| List offers | List the offers made on an opportunity, one page of up to 100 at a time: each offer's status, its fields (such as salary and start date) and its sent and signed documents. |
| List opportunities | List opportunities, one page of up to 100 at a time. |
| List postings | List job postings, one page of up to 100 at a time: each one's title (returned as text), state, team, department, location, the user ids of its owner and hiring manager, and its links. |
| List requisitions | List requisitions (the approved openings that postings hire against), one page of up to 100 at a time. |
| List sources | List the candidate sources in use in the account (such as LinkedIn or Referral), each with how many candidates have it. |
| List stages | List every stage of the account's hiring pipeline, as an id and a name (returned as text). |
| List tags | List the tags in use in the account, each with how many candidates have it. |
| List users | List the people who have a Lever account, one page of up to 100 at a time: name, email, job title and access role. |
| Remove opportunity tags | Remove one or more tags from an opportunity. |
Add opportunity tags
Add one or more tags to an opportunity.
Inputs
- Opportunity
opportunity_idtextRequired - The opportunity (one candidate's candidacy for a job). Pick one, or pass the id of an opportunity from an earlier step, such as a list or a trigger's record.
- Perform as
perform_astext - The Lever user this is recorded as done by. Pick one, or pass a user's id from List users. Blank records it against the API key rather than a person.
- Tags
tagslistRequired - The tags to add: at least one.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": {},
"hasNext": false,
"next": null
}
}Archive opportunity
Archive an opportunity with an archive reason (such as hired, withdrew or not a fit, as set up in your Lever account), which takes the candidate out of the active pipeline.
Inputs
- Opportunity
opportunity_idtextRequired - The opportunity (one candidate's candidacy for a job). Pick one, or pass the id of an opportunity from an earlier step, such as a list or a trigger's record.
- Perform as
perform_astext - The Lever user this is recorded as done by. Pick one, or pass a user's id from List users. Blank records it against the API key rather than a person.
- Reason
reasontextRequired - Why the candidate is being archived. Pick a reason, or pass an archive reason's id from List archive reasons.
- Clean interviews
clean_interviewstrue/false - Turn on to also remove the candidate's pending interviews from Lever when archiving.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": {},
"hasNext": false,
"next": null
}
}Change opportunity stage
Move an opportunity (a candidate) to another stage of the hiring pipeline, picked by name or given as a stage id from List stages.
Inputs
- Opportunity
opportunity_idtextRequired - The opportunity (one candidate's candidacy for a job). Pick one, or pass the id of an opportunity from an earlier step, such as a list or a trigger's record.
- Perform as
perform_astext - The Lever user this is recorded as done by. Pick one, or pass a user's id from List users. Blank records it against the API key rather than a person.
- Stage
stagetextRequired - The pipeline stage to move the candidate to. Pick one, or pass a stage's id from List stages (the id, not the name).
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": {},
"hasNext": false,
"next": null
}
}Create note
Add a note to an opportunity's profile in Lever. The note can be secret, carry a score and notify the opportunity's followers, and an @-mention in its text notifies the colleague named.
Inputs
- Opportunity
opportunity_idtextRequired - The opportunity (one candidate's candidacy for a job). Pick one, or pass the id of an opportunity from an earlier step, such as a list or a trigger's record.
- Perform as
perform_astext - The Lever user this is recorded as done by. Pick one, or pass a user's id from List users. Blank records it against the API key rather than a person.
- Text
texttextRequired - What the note says. Write @ and a colleague's Lever username to mention them.
- Secret
secrettrue/false - Turn on to make the note visible only to people with access to sensitive information in Lever. Off or blank means everyone who can see the candidate can read it.
- Score
scorenumber - An optional rating of the candidate to record with the note, from 1 (lowest) to 4 (highest).One of:
1,2,3,4. - Notify followers
notify_followerstrue/false - Turn on to have Lever notify the people following this opportunity about the note. Off or blank notifies nobody but anyone mentioned.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": {},
"hasNext": false,
"next": null
}
}Create opportunity
Add a candidate to Lever as a new opportunity, optionally against a posting, in a stage and with an owner. Lever needs to know which of its users to record as having added the candidate.
Inputs
- Perform as
perform_astextRequired - The Lever user recorded as having added the candidate. Pick one, or pass a user's id from List users.
- Name
nametextRequired - The candidate's full name.
- Emails
emailslistRequired - The candidate's email addresses; at least one.
- Headline
headlinetext - A short line shown under the candidate's name, usually their current or past companies.
- Location
locationtext - Where the candidate is, as free text such as Berlin, Germany.
- Stage
stagetext - The pipeline stage to put the candidate in. Pick one, or pass a stage's id from List stages (the id, not the name). Blank lets Lever choose its first stage for the candidate's origin.
- Origin
origintext - How the candidate came to you. Blank lets Lever decide.One of:
agency,applied,internal,referred,sourced,university. - Owner
ownertext - The Lever user responsible for this candidate, usually the recruiter. Pick one, or pass a user's id from List users. Blank leaves the owner to Lever.
- Postings
postingslist - The job posting the candidate is being considered for: at most one. Pick it, or pass a posting's id from List postings. Blank adds a general candidate with no job.
- Tags
tagslist - Tags to put on the opportunity.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": {},
"hasNext": false,
"next": null
}
}Get contact
Get a contact, the person behind one or more opportunities: name, headline, location, emails and phone numbers. An opportunity's contact field holds the contact's id.
Inputs
- Contact ID
contact_idtextRequired - The contact's id: the contact value on an opportunity.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": {
"emails": [],
"headline": "example",
"id": "example",
"isAnonymized": false,
"location": {
"addressLine1": "example",
"addressLine2": "example",
"city": "example",
"country": "example",
"name": "example",
"postalCode": "example",
"region": "example"
},
"name": "example",
"phones": [
{
"type": "example",
"value": "example"
}
]
}
}
}Get interview
Get one interview on an opportunity by the interview's id: subject, date (epoch milliseconds), length in minutes, location, the interviewers' names and emails, and when it was cancelled if it was.
Inputs
- Opportunity
opportunity_idtextRequired - The opportunity (one candidate's candidacy for a job). Pick one, or pass the id of an opportunity from an earlier step, such as a list or a trigger's record.
- Interview ID
interview_idtextRequired - The interview's id: the id of an interview from List interviews.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": {
"canceledAt": null,
"conferences": [
{
"entryPoints": [
{
"type": "example",
"uri": "example"
}
],
"source": "example"
}
],
"createdAt": 1,
"date": 1,
"duration": 1,
"feedbackForms": [],
"feedbackReminder": "example",
"feedbackTemplate": "example",
"id": "example",
"interviewers": [
{
"email": "example",
"feedbackTemplate": "example",
"id": "example",
"name": "example"
}
],
"location": "example",
"note": "example",
"panel": "example",
"postings": [],
"stage": "example",
"subject": "example",
"timezone": "example",
"user": "example"
}
}
}Get note
Get one note on an opportunity by the note's id: its text, the id of the user who wrote it, whether it is secret and when it was written (epoch milliseconds).
Inputs
- Opportunity
opportunity_idtextRequired - The opportunity (one candidate's candidacy for a job). Pick one, or pass the id of an opportunity from an earlier step, such as a list or a trigger's record.
- Note ID
note_idtextRequired - The note's id: the id of a note from List notes.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": {
"completedAt": 1794301200000,
"createdAt": 1794301200000,
"deletedAt": 1,
"fields": [
{
"createdAt": 1,
"score": 1,
"stage": "example",
"text": "example",
"type": "example",
"user": "example",
"value": "example"
}
],
"id": "0e0dd94c-b1a0-4e2a-a8cc-2c4cd3b5f8a1",
"secret": false,
"text": "Strong phone screen; move to onsite.",
"user": "df0adaa6-172c-4cd6-8520-49b203660fe1"
}
}
}Get opportunity
Get one opportunity (one person's candidacy for a job) by its id: the candidate's name, emails and headline, the stage it is in, its owner (the Lever user responsible for it, usually the recruiter), tags, sources and a link that opens it in Lever. Stage and owner are ids unless Expand asks for the full records; every time is in epoch milliseconds.
Inputs
- Opportunity
opportunity_idtextRequired - The opportunity (one candidate's candidacy for a job). Pick one, or pass the id of an opportunity from an earlier step, such as a list or a trigger's record.
- Expand
expandlist - Fields to return as full records instead of ids: with stage the result's stage is the stage record (id and text, its name) and with owner its owner is the user record (name, email). Blank leaves them as ids.One or more of:
applications,stage,owner,followers,sourcedBy,contact.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": {
"applications": [
"cdb4ff13-f7aa-49b0-b6ec-eb4617009cfa"
],
"archiveReason": null,
"archivedAt": null,
"confidentiality": "non-confidential",
"contact": "7f23e772-f2cb-4ebb-b33f-54b872999992",
"createdAt": 1793696400000,
"dataProtection": {
"contact": {
"allowed": false,
"expiresAt": null
},
"store": {
"allowed": false,
"expiresAt": 1
}
},
"emails": [
"shane@example.com"
],
"followers": [
"df0adaa6-172c-4cd6-8520-49b203660fe1"
],
"headline": "Brickly LLC, Vandelay Industries, Inc",
"id": "250d8f03-738a-4bba-a671-8a3d73477145",
"isAnonymized": false,
"lastAdvancedAt": 1793696400000,
"lastInteractionAt": 1794301200000,
"links": [
"linkedin.com/in/shane-smith"
],
"location": "Oakland, CA",
"locationDetails": {
"addressLine1": "example",
"city": "example",
"country": "example",
"postalCode": "example",
"region": "example"
},
"name": "Shane Smith",
"origin": "sourced",
"owner": "df0adaa6-172c-4cd6-8520-49b203660fe1",
"phones": [
{
"value": "(123) 456-7891"
}
],
"resume": null,
"snoozedUntil": 1,
"sourcedBy": "df0adaa6-172c-4cd6-8520-49b203660fe1",
"sources": [
"linkedin"
],
"stage": "00922a60-7c15-422b-b086-f62000824fd7",
"stageChanges": [
{
"toStageId": "00922a60-7c15-422b-b086-f62000824fd7",
"toStageIndex": 1,
"updatedAt": 1793696400000,
"userId": "df0adaa6-172c-4cd6-8520-49b203660fe1"
}
],
"tags": [
"San Francisco",
"Full-time"
],
"updatedAt": 1794301200000,
"urls": {
"list": "https://hire.lever.co/candidates",
"show": "https://hire.lever.co/candidates/250d8f03-738a-4bba-a671-8a3d73477145"
}
}
}
}Get posting
Get one job posting by its id: its title (returned as text), state, team, department, location, description, the user ids of its owner and hiring manager, and its links.
Inputs
- Posting
posting_idtextRequired - The job posting. Pick one, or pass a posting's id from List postings.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": {
"categories": {
"allLocations": [],
"commitment": "Full-time",
"department": "Engineering",
"level": "example",
"location": "San Francisco",
"locationDetails": {
"addressLine1": "example",
"addressLine2": "example",
"city": "example",
"country": "example",
"postalCode": "example",
"region": "example"
},
"team": "Platform"
},
"confidentiality": "non-confidential",
"content": {
"closing": "example",
"closingHtml": "example",
"description": "example",
"descriptionHtml": "example",
"lists": [
{
"content": "example",
"text": "example"
}
]
},
"country": "US",
"createdAt": 1731402000000,
"distributionChannels": [],
"hiringManager": "df0adaa6-172c-4cd6-8520-49b203660fe1",
"id": "f2f01e16-27f8-4711-a728-7d49499795a0",
"owner": "df0adaa6-172c-4cd6-8520-49b203660fe1",
"reqCode": "example",
"requisitionCodes": [],
"salaryDescription": "example",
"salaryDescriptionHtml": "example",
"salaryRange": {
"currency": "example",
"interval": "example",
"max": 1,
"min": 1
},
"state": "published",
"tags": [],
"text": "Infrastructure Engineer",
"updatedAt": 1793696400000,
"urls": {
"apply": "https://jobs.lever.co/example/f2f01e16-27f8-4711-a728-7d49499795a0/apply",
"list": "https://jobs.lever.co/example",
"show": "https://jobs.lever.co/example/f2f01e16-27f8-4711-a728-7d49499795a0"
},
"user": "df0adaa6-172c-4cd6-8520-49b203660fe1",
"workplaceType": "hybrid"
}
}
}Get stage
Get one pipeline stage's name (returned as text) from its id, such as the stage id on an opportunity.
Inputs
- Stage
stage_idtextRequired - The pipeline stage. Pick one, or pass a stage id, such as the stage value on an opportunity.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": {
"id": "00922a60-7c15-422b-b086-f62000824fd7",
"text": "Phone screen"
}
}
}Get user
Get one Lever user by id: name, email, job title and access role. Use it to turn the owner id on an opportunity into the recruiter's name and email address.
Inputs
- Target user
target_user_idtextRequired - The Lever user. Pick one, or pass a user id, such as the owner value on an opportunity or the hiringManager value on a posting.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": {
"accessRole": "team member",
"createdAt": 1731402000000,
"deactivatedAt": 1,
"email": "rachel@example.com",
"externalDirectoryId": "example",
"id": "df0adaa6-172c-4cd6-8520-49b203660fe1",
"jobTitle": "Senior Recruiter",
"linkedContactIds": [],
"managerId": "example",
"name": "Rachel Green",
"photo": "example",
"username": "rachel"
}
}
}List archive reasons
List the reasons an opportunity can be archived with in this account, as an id and a name (returned as text). Archive opportunity takes one of these ids.
Inputs
None.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": [
{
"id": "example",
"status": "example",
"text": "example",
"type": "example"
}
]
}
}List candidates waiting in a stage
(beta) List the active candidates who have been in their current pipeline stage for more than a number of days, with their name and email, the stage, how many days they have waited, the job they applied to, a link to them in Lever, and their owner (usually the recruiter). The same candidates also come grouped by owner in by_owner, so you can send each recruiter their own list. Archived candidates are left out.
Inputs
- Waiting more than this many days
daysnumber - List candidates who reached their current stage more than this many days ago. A whole number; blank means 7. 0 lists every active candidate.From 0 to 3650. Default:
7. - Posting
posting_idtext - Only candidates who applied to this job posting. Pick one, or pass a posting's id from List postings. Blank means every posting.
- Stage
stage_idtext - Only candidates waiting in this pipeline stage, such as the one for phone screens. Pick one, or pass a stage's id from List stages. Blank means every stage.
Outputs
by_ownerlist- The same candidates, one record per owner, in order of the owner's name. Loop over this to tell each recruiter about theirs. Candidates with no owner are in a last group whose `owner_email` and `owner_name` are "".
candidateslist- Every waiting candidate, the longest-waiting first.
countnumber- How many candidates are waiting. 0 when nobody is.
Example output
{
"by_owner": [
{
"candidates": [
{
"days_in_stage": 16,
"email": "shane@example.com",
"headline": "Brickly LLC, Vandelay Industries, Inc",
"id": "250d8f03-738a-4bba-a671-8a3d73477145",
"in_stage_since": "2026-10-24T15:20:00Z",
"in_stage_since_display": "Oct 24, 2026",
"link": "https://hire.lever.co/candidates/250d8f03-738a-4bba-a671-8a3d73477145",
"name": "Shane Smith",
"owner_email": "rachel@example.com",
"owner_id": "df0adaa6-172c-4cd6-8520-49b203660fe1",
"owner_name": "Rachel Green",
"posting": "Infrastructure Engineer",
"posting_id": "f2f01e16-27f8-4711-a728-7d49499795a0",
"stage": "Phone screen",
"stage_id": "00922a60-7c15-422b-b086-f62000824fd7"
},
{
"days_in_stage": 9,
"email": "priya@example.com",
"headline": "Initech",
"id": "5c86dcc2-4e3c-4d62-9c0f-0f4d2b9a3d10",
"in_stage_since": "2026-10-31T09:05:00Z",
"in_stage_since_display": "Oct 31, 2026",
"link": "https://hire.lever.co/candidates/5c86dcc2-4e3c-4d62-9c0f-0f4d2b9a3d10",
"name": "Priya Raman",
"owner_email": "rachel@example.com",
"owner_id": "df0adaa6-172c-4cd6-8520-49b203660fe1",
"owner_name": "Rachel Green",
"posting": "Product Designer",
"posting_id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"stage": "On-site interview",
"stage_id": "3f6fa6a1-9f4c-4e5b-8d2c-2d6a8a2f5e77"
}
],
"count": 2,
"owner_email": "rachel@example.com",
"owner_id": "df0adaa6-172c-4cd6-8520-49b203660fe1",
"owner_name": "Rachel Green"
},
{
"candidates": [
{
"days_in_stage": 12,
"email": "tom@example.com",
"headline": "",
"id": "9a7d3b1e-6c2f-4f0a-b5e8-1d2c3b4a5f60",
"in_stage_since": "2026-10-28T18:42:00Z",
"in_stage_since_display": "Oct 28, 2026",
"link": "https://hire.lever.co/candidates/9a7d3b1e-6c2f-4f0a-b5e8-1d2c3b4a5f60",
"name": "Tom Okafor",
"owner_email": "",
"owner_id": "",
"owner_name": "",
"posting": "Infrastructure Engineer",
"posting_id": "f2f01e16-27f8-4711-a728-7d49499795a0",
"stage": "New applicant",
"stage_id": "lead-new"
}
],
"count": 1,
"owner_email": "",
"owner_id": "",
"owner_name": ""
}
],
"candidates": [
{
"days_in_stage": 16,
"email": "shane@example.com",
"headline": "Brickly LLC, Vandelay Industries, Inc",
"id": "250d8f03-738a-4bba-a671-8a3d73477145",
"in_stage_since": "2026-10-24T15:20:00Z",
"in_stage_since_display": "Oct 24, 2026",
"link": "https://hire.lever.co/candidates/250d8f03-738a-4bba-a671-8a3d73477145",
"name": "Shane Smith",
"owner_email": "rachel@example.com",
"owner_id": "df0adaa6-172c-4cd6-8520-49b203660fe1",
"owner_name": "Rachel Green",
"posting": "Infrastructure Engineer",
"posting_id": "f2f01e16-27f8-4711-a728-7d49499795a0",
"stage": "Phone screen",
"stage_id": "00922a60-7c15-422b-b086-f62000824fd7"
},
{
"days_in_stage": 12,
"email": "tom@example.com",
"headline": "",
"id": "9a7d3b1e-6c2f-4f0a-b5e8-1d2c3b4a5f60",
"in_stage_since": "2026-10-28T18:42:00Z",
"in_stage_since_display": "Oct 28, 2026",
"link": "https://hire.lever.co/candidates/9a7d3b1e-6c2f-4f0a-b5e8-1d2c3b4a5f60",
"name": "Tom Okafor",
"owner_email": "",
"owner_id": "",
"owner_name": "",
"posting": "Infrastructure Engineer",
"posting_id": "f2f01e16-27f8-4711-a728-7d49499795a0",
"stage": "New applicant",
"stage_id": "lead-new"
},
{
"days_in_stage": 9,
"email": "priya@example.com",
"headline": "Initech",
"id": "5c86dcc2-4e3c-4d62-9c0f-0f4d2b9a3d10",
"in_stage_since": "2026-10-31T09:05:00Z",
"in_stage_since_display": "Oct 31, 2026",
"link": "https://hire.lever.co/candidates/5c86dcc2-4e3c-4d62-9c0f-0f4d2b9a3d10",
"name": "Priya Raman",
"owner_email": "rachel@example.com",
"owner_id": "df0adaa6-172c-4cd6-8520-49b203660fe1",
"owner_name": "Rachel Green",
"posting": "Product Designer",
"posting_id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"stage": "On-site interview",
"stage_id": "3f6fa6a1-9f4c-4e5b-8d2c-2d6a8a2f5e77"
}
],
"count": 3
}List feedback
List the interview feedback forms filled in for an opportunity, one page of up to 100 at a time, each with its questions and the answers given.
Inputs
- Opportunity
opportunity_idtextRequired - The opportunity (one candidate's candidacy for a job). Pick one, or pass the id of an opportunity from an earlier step, such as a list or a trigger's record.
- Limit
limitnumber - How many to return in this page, from 1 to 100. Blank means 100.From 1 to 100. Default:
100. - Offset
offsettext - Which page to read. Leave blank for the first page. For the next page pass the data.next value the previous page returned, and stop when its data.hasNext is false. Lever accepts only a value it handed back, never a number such as 100.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": [
{
"baseTemplateId": "example",
"completedAt": 1,
"createdAt": 1,
"deletedAt": 1,
"fields": [
{
"description": "example",
"id": "example",
"options": [
{
"text": "example"
}
],
"prompt": "example",
"required": false,
"text": "example",
"type": "example",
"value": "example"
}
],
"id": "example",
"instructions": "example",
"interview": "example",
"panel": "example",
"text": "example",
"type": "example",
"updatedAt": 1,
"user": "example"
}
],
"hasNext": false,
"next": null
}
}List interviews
List the interviews scheduled for an opportunity, one page of up to 100 at a time: subject, date (epoch milliseconds), length in minutes, location, the interviewers' names and emails, and when it was cancelled if it was.
Inputs
- Opportunity
opportunity_idtextRequired - The opportunity (one candidate's candidacy for a job). Pick one, or pass the id of an opportunity from an earlier step, such as a list or a trigger's record.
- Limit
limitnumber - How many to return in this page, from 1 to 100. Blank means 100.From 1 to 100. Default:
100. - Offset
offsettext - Which page to read. Leave blank for the first page. For the next page pass the data.next value the previous page returned, and stop when its data.hasNext is false. Lever accepts only a value it handed back, never a number such as 100.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": [
{
"canceledAt": null,
"conferences": [
{
"entryPoints": [
{
"type": "example",
"uri": "example"
}
],
"source": "example"
}
],
"createdAt": 1,
"date": 1,
"duration": 1,
"feedbackForms": [],
"feedbackReminder": "example",
"feedbackTemplate": "example",
"id": "example",
"interviewers": [
{
"email": "example",
"feedbackTemplate": "example",
"id": "example",
"name": "example"
}
],
"location": "example",
"note": "example",
"panel": "example",
"postings": [],
"stage": "example",
"subject": "example",
"timezone": "example",
"user": "example"
}
],
"hasNext": false,
"next": null
}
}List interviews on a day
Beta. Every interview scheduled in Lever on one day, across all active candidates, each with the candidate's name and link, the role, and its start time written for a person. Cancelled interviews and archived candidates are left out. by_interviewer groups them per interviewer with their email and ready-to-send lines, so 'email each interviewer their interviews today' needs no loop over candidates, date filter, posting lookup or grouping step. It checks up to 500 active candidates (all_checked says whether that was all of them), so it can take a minute or two.
Inputs
- Day
daytext - Beta. The day to list: today, tomorrow, or a date written YYYY-MM-DD. Leave empty for today.
- Time zone
time_zonetext - Beta. The time zone that decides which day 'today' is and shows the times, such as America/New_York. Leave empty to use the workflow owner's time zone, the one a schedule runs in (UTC if they haven't set one).
Outputs
all_checkedtrue/false- False when there were more active candidates than the 500 checked, so some interviews may be missing
by_interviewerlist- Beta. The interviews grouped per interviewer, for one message each. Interviews with no interviewer are left out.
countnumber- How many interviews there are
daytext- The day listed (YYYY-MM-DD)
interviewslist- The day's interviews, earliest first
opportunities_checkednumber- How many active candidates were checked
Example output
{
"all_checked": true,
"by_interviewer": [
{
"count": 1,
"email": "rachel@example.com",
"first_name": "Rachel",
"interviews": [
{
"candidate_link": "https://hire.lever.co/candidates/250d8f03-738a-4bba-a671-8a3d73477145",
"candidate_name": "Shane Smith",
"duration_minutes": 45,
"interview_id": "6a8c3f2e-1b7d-4e0a-9c55-2f1d7e3b9a10",
"interviewers": [
{
"email": "rachel@example.com",
"name": "Rachel Green"
}
],
"location": "Room 4B",
"opportunity_id": "250d8f03-738a-4bba-a671-8a3d73477145",
"role": "Software Engineer",
"start": "2026-11-12T09:30:00-05:00",
"subject": "On-site interview - Shane Smith",
"time_display": "9:30 AM EST"
}
],
"lines": "\u2022 9:30 AM EST: Shane Smith for Software Engineer: https://hire.lever.co/candidates/250d8f03-738a-4bba-a671-8a3d73477145",
"name": "Rachel Green"
}
],
"count": 1,
"day": "2026-11-12",
"interviews": [
{
"candidate_link": "https://hire.lever.co/candidates/250d8f03-738a-4bba-a671-8a3d73477145",
"candidate_name": "Shane Smith",
"duration_minutes": 45,
"interview_id": "6a8c3f2e-1b7d-4e0a-9c55-2f1d7e3b9a10",
"interviewers": [
{
"email": "rachel@example.com",
"name": "Rachel Green"
}
],
"location": "Room 4B",
"opportunity_id": "250d8f03-738a-4bba-a671-8a3d73477145",
"role": "Software Engineer",
"start": "2026-11-12T09:30:00-05:00",
"subject": "On-site interview - Shane Smith",
"time_display": "9:30 AM EST"
}
],
"opportunities_checked": 42
}List notes
List the notes on an opportunity, one page of up to 100 at a time: each note's text, the id of the user who wrote it, whether it is secret and when it was written (epoch milliseconds).
Inputs
- Opportunity
opportunity_idtextRequired - The opportunity (one candidate's candidacy for a job). Pick one, or pass the id of an opportunity from an earlier step, such as a list or a trigger's record.
- Limit
limitnumber - How many to return in this page, from 1 to 100. Blank means 100.From 1 to 100. Default:
100. - Offset
offsettext - Which page to read. Leave blank for the first page. For the next page pass the data.next value the previous page returned, and stop when its data.hasNext is false. Lever accepts only a value it handed back, never a number such as 100.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": [
{
"completedAt": 1794301200000,
"createdAt": 1794301200000,
"deletedAt": 1,
"fields": [
{
"createdAt": 1,
"score": 1,
"stage": "example",
"text": "example",
"type": "example",
"user": "example",
"value": "example"
}
],
"id": "0e0dd94c-b1a0-4e2a-a8cc-2c4cd3b5f8a1",
"secret": false,
"text": "Strong phone screen; move to onsite.",
"user": "df0adaa6-172c-4cd6-8520-49b203660fe1"
}
],
"hasNext": false,
"next": null
}
}List offers
List the offers made on an opportunity, one page of up to 100 at a time: each offer's status, its fields (such as salary and start date) and its sent and signed documents.
Inputs
- Opportunity
opportunity_idtextRequired - The opportunity (one candidate's candidacy for a job). Pick one, or pass the id of an opportunity from an earlier step, such as a list or a trigger's record.
- Limit
limitnumber - How many to return in this page, from 1 to 100. Blank means 100.From 1 to 100. Default:
100. - Offset
offsettext - Which page to read. Leave blank for the first page. For the next page pass the data.next value the previous page returned, and stop when its data.hasNext is false. Lever accepts only a value it handed back, never a number such as 100.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": [
{
"createdAt": 1,
"creator": "example",
"fields": [
{
"identifier": "example",
"text": "example",
"value": "example"
}
],
"id": "example",
"sentDocument": {
"downloadUrl": "example",
"fileName": "example",
"uploadedAt": 1
},
"signedDocument": {
"downloadUrl": "example",
"fileName": "example",
"uploadedAt": 1
},
"status": "example"
}
],
"hasNext": false,
"next": null
}
}List opportunities
List opportunities, one page of up to 100 at a time. An opportunity is one person's candidacy for a job; Lever's own screens call it a candidate. Returns active and archived ones alike unless Archived is set, and can be narrowed to a stage, a posting, a tag, an email address or a contact. Stage and owner come back as ids and every time as epoch milliseconds. To find the candidates who have waited too long in a stage, with names, recruiters and day counts worked out across every page, use List candidates waiting in a stage instead.
Inputs
- Limit
limitnumber - How many opportunities to return on this page, from 1 to 100 (default 100). To read more, pass the next value this step returns as Offset in a following List opportunities step.From 1 to 100. Default:
100. - Offset
offsettext - Where to start reading: leave empty for the first page. For the following page, use the next value an earlier List opportunities step returned (only while its hasNext is true).
- Email
emailtext - Only the opportunities of the candidate with this email address.
- Stage
stage_idtext - Only opportunities now in this pipeline stage. Pick one, or pass a stage's id from List stages (the id, not the name). Blank means every stage.
- Contact ID
contact_idtext - Only the opportunities of this contact (person): the contact value on an opportunity. One person can have several opportunities, one per job.
- Tag
tagtext - Only opportunities carrying this tag, written exactly as it is in Lever.
- Created since
created_sincedate and time - Only opportunities created at or after this date and time. Give a date and time; it is converted to Lever's epoch milliseconds for you.
- Archived
archivedtrue/false - (beta) Off returns only active candidates, those still in the pipeline; on returns only archived ones (hired, rejected, withdrawn). Blank returns both.
- Posting
posting_idtext - (beta) Only opportunities applied to this job posting. Pick one, or pass a posting's id from List postings. Blank means every posting.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": [
{
"applications": [
"cdb4ff13-f7aa-49b0-b6ec-eb4617009cfa"
],
"archiveReason": null,
"archivedAt": null,
"confidentiality": "non-confidential",
"contact": "7f23e772-f2cb-4ebb-b33f-54b872999992",
"createdAt": 1793696400000,
"dataProtection": {
"contact": {
"allowed": false,
"expiresAt": null
},
"store": {
"allowed": false,
"expiresAt": 1
}
},
"emails": [
"shane@example.com"
],
"followers": [
"df0adaa6-172c-4cd6-8520-49b203660fe1"
],
"headline": "Brickly LLC, Vandelay Industries, Inc",
"id": "250d8f03-738a-4bba-a671-8a3d73477145",
"isAnonymized": false,
"lastAdvancedAt": 1793696400000,
"lastInteractionAt": 1794301200000,
"links": [
"linkedin.com/in/shane-smith"
],
"location": "Oakland, CA",
"locationDetails": {
"addressLine1": "example",
"city": "example",
"country": "example",
"postalCode": "example",
"region": "example"
},
"name": "Shane Smith",
"origin": "sourced",
"owner": "df0adaa6-172c-4cd6-8520-49b203660fe1",
"phones": [
{
"value": "(123) 456-7891"
}
],
"resume": null,
"snoozedUntil": 1,
"sourcedBy": "df0adaa6-172c-4cd6-8520-49b203660fe1",
"sources": [
"linkedin"
],
"stage": "00922a60-7c15-422b-b086-f62000824fd7",
"stageChanges": [
{
"toStageId": "00922a60-7c15-422b-b086-f62000824fd7",
"toStageIndex": 1,
"updatedAt": 1793696400000,
"userId": "df0adaa6-172c-4cd6-8520-49b203660fe1"
}
],
"tags": [
"San Francisco",
"Full-time"
],
"updatedAt": 1794301200000,
"urls": {
"list": "https://hire.lever.co/candidates",
"show": "https://hire.lever.co/candidates/250d8f03-738a-4bba-a671-8a3d73477145"
}
}
],
"hasNext": false,
"next": "example"
}
}List postings
List job postings, one page of up to 100 at a time: each one's title (returned as text), state, team, department, location, the user ids of its owner and hiring manager, and its links.
Inputs
- Limit
limitnumber - How many to return in this page, from 1 to 100. Blank means 100.From 1 to 100. Default:
100. - Offset
offsettext - Which page to read. Leave blank for the first page. For the next page pass the data.next value the previous page returned, and stop when its data.hasNext is false. Lever accepts only a value it handed back, never a number such as 100.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": [
{
"categories": {
"allLocations": [],
"commitment": "Full-time",
"department": "Engineering",
"level": "example",
"location": "San Francisco",
"locationDetails": {
"addressLine1": "example",
"addressLine2": "example",
"city": "example",
"country": "example",
"postalCode": "example",
"region": "example"
},
"team": "Platform"
},
"confidentiality": "non-confidential",
"content": {
"closing": "example",
"closingHtml": "example",
"description": "example",
"descriptionHtml": "example",
"lists": [
{
"content": "example",
"text": "example"
}
]
},
"country": "US",
"createdAt": 1731402000000,
"distributionChannels": [],
"hiringManager": "df0adaa6-172c-4cd6-8520-49b203660fe1",
"id": "f2f01e16-27f8-4711-a728-7d49499795a0",
"owner": "df0adaa6-172c-4cd6-8520-49b203660fe1",
"reqCode": "example",
"requisitionCodes": [],
"salaryDescription": "example",
"salaryDescriptionHtml": "example",
"salaryRange": {
"currency": "example",
"interval": "example",
"max": 1,
"min": 1
},
"state": "published",
"tags": [],
"text": "Infrastructure Engineer",
"updatedAt": 1793696400000,
"urls": {
"apply": "https://jobs.lever.co/example/f2f01e16-27f8-4711-a728-7d49499795a0/apply",
"list": "https://jobs.lever.co/example",
"show": "https://jobs.lever.co/example/f2f01e16-27f8-4711-a728-7d49499795a0"
},
"user": "df0adaa6-172c-4cd6-8520-49b203660fe1",
"workplaceType": "hybrid"
}
],
"hasNext": false,
"next": null
}
}List requisitions
List requisitions (the approved openings that postings hire against), one page of up to 100 at a time.
Inputs
- Limit
limitnumber - How many to return in this page, from 1 to 100. Blank means 100.From 1 to 100. Default:
100. - Offset
offsettext - Which page to read. Leave blank for the first page. For the next page pass the data.next value the previous page returned, and stop when its data.hasNext is false. Lever accepts only a value it handed back, never a number such as 100.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": [],
"hasNext": false,
"next": null
}
}List sources
List the candidate sources in use in the account (such as LinkedIn or Referral), each with how many candidates have it.
Inputs
None.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": [
{
"count": 1,
"text": "example"
}
]
}
}List stages
List every stage of the account's hiring pipeline, as an id and a name (returned as text). Use it to turn the stage id on an opportunity into a name, or to find the id of the stage to move a candidate to.
Inputs
None.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": [
{
"id": "00922a60-7c15-422b-b086-f62000824fd7",
"text": "Phone screen"
}
]
}
}List tags
List the tags in use in the account, each with how many candidates have it.
Inputs
None.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": [
{
"count": 1,
"text": "example"
}
]
}
}List users
List the people who have a Lever account, one page of up to 100 at a time: name, email, job title and access role. An opportunity's owner, a posting's hiring manager and a note's author are ids of these users.
Inputs
- Limit
limitnumber - How many to return in this page, from 1 to 100. Blank means 100.From 1 to 100. Default:
100. - Offset
offsettext - Which page to read. Leave blank for the first page. For the next page pass the data.next value the previous page returned, and stop when its data.hasNext is false. Lever accepts only a value it handed back, never a number such as 100.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": [
{
"accessRole": "team member",
"createdAt": 1731402000000,
"deactivatedAt": 1,
"email": "rachel@example.com",
"externalDirectoryId": "example",
"id": "df0adaa6-172c-4cd6-8520-49b203660fe1",
"jobTitle": "Senior Recruiter",
"linkedContactIds": [],
"managerId": "example",
"name": "Rachel Green",
"photo": "example",
"username": "rachel"
}
],
"hasNext": false,
"next": null
}
}Remove opportunity tags
Remove one or more tags from an opportunity.
Inputs
- Opportunity
opportunity_idtextRequired - The opportunity (one candidate's candidacy for a job). Pick one, or pass the id of an opportunity from an earlier step, such as a list or a trigger's record.
- Perform as
perform_astext - The Lever user this is recorded as done by. Pick one, or pass a user's id from List users. Blank records it against the API key rather than a person.
- Tags
tagslistRequired - The tags to remove: at least one.
Outputs
dataobject- What Lever answered. Lever puts its records under a `data` of its own, so they are read as `data.data` from this step's result.
Example output
{
"data": {
"data": {},
"hasNext": false,
"next": null
}
}