Lever · Schema

Lever Opportunity

An Opportunity in Lever represents a candidate (Contact) being considered for one or more job postings. Opportunities replaced the legacy Candidate resource and are the unified record across the recruiting pipeline.

Applicant TrackingATSCRMRecruitingHiringTalent AcquisitionHuman ResourcesHR TechPostingsWebhooksOAuth

Properties

Name Type Description
id string Opportunity UUID.
name string Candidate's name.
contact string ID of the underlying Contact (the person across all opportunities).
headline string Short candidate headline.
stage string ID of the current pipeline stage.
location string
emails array
phones array
archived objectnull
createdAt integer
updatedAt integer
lastInteractionAt integer
lastAdvancedAt integer
snoozedUntil integernull
applications array
sources array
origin string
owner string
followers array
tags array
isAnonymized boolean
links array
urls object
View JSON Schema on GitHub

JSON Schema

lever-opportunity-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/lever-co/main/json-schema/lever-opportunity-schema.json",
  "title": "Lever Opportunity",
  "description": "An Opportunity in Lever represents a candidate (Contact) being considered for one or more job postings. Opportunities replaced the legacy Candidate resource and are the unified record across the recruiting pipeline.",
  "type": "object",
  "required": ["id"],
  "properties": {
    "id": {
      "type": "string",
      "description": "Opportunity UUID."
    },
    "name": {
      "type": "string",
      "description": "Candidate's name."
    },
    "contact": {
      "type": "string",
      "description": "ID of the underlying Contact (the person across all opportunities)."
    },
    "headline": {
      "type": "string",
      "description": "Short candidate headline."
    },
    "stage": {
      "type": "string",
      "description": "ID of the current pipeline stage."
    },
    "location": {
      "type": "string"
    },
    "emails": {
      "type": "array",
      "items": { "type": "string", "format": "email" }
    },
    "phones": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": { "type": "string", "enum": ["mobile", "home", "work", "skype", "other"] },
          "value": { "type": "string" }
        }
      }
    },
    "archived": {
      "type": ["object", "null"],
      "properties": {
        "archivedAt": { "type": "integer", "format": "int64" },
        "reason": { "type": "string" }
      }
    },
    "createdAt": { "type": "integer", "format": "int64" },
    "updatedAt": { "type": "integer", "format": "int64" },
    "lastInteractionAt": { "type": "integer", "format": "int64" },
    "lastAdvancedAt": { "type": "integer", "format": "int64" },
    "snoozedUntil": { "type": ["integer", "null"], "format": "int64" },
    "applications": {
      "type": "array",
      "items": { "type": "string" }
    },
    "sources": {
      "type": "array",
      "items": { "type": "string" }
    },
    "origin": {
      "type": "string",
      "enum": ["agency", "applied", "internal", "referred", "sourced", "university"]
    },
    "owner": { "type": "string" },
    "followers": {
      "type": "array",
      "items": { "type": "string" }
    },
    "tags": {
      "type": "array",
      "items": { "type": "string" }
    },
    "isAnonymized": { "type": "boolean" },
    "links": {
      "type": "array",
      "items": { "type": "string", "format": "uri" }
    },
    "urls": {
      "type": "object",
      "properties": {
        "list": { "type": "string", "format": "uri" },
        "show": { "type": "string", "format": "uri" }
      }
    }
  }
}