Lead Schema

The lead object represents a hiring process. A single person can have multiple hiring processes with a company. This is represented by multiple candidate and/or leads objects that have the same person_uid.

Field	Type	Description
uid	string	lead UID
person_uid	string	The lead's person UID. Each person can have multiple candidate and/or leads objects associated with it. Each lead object represents a hiring process.
first_name	string
middle_name	string
last_name	string
email	string
phone	string
mobile_phone	string
id_number	string
linkedin_url	string
deleted	boolean	Indicates whether the lead has been deleted. When `true` the lead object will only include the `uid`
position_uid	string	Position UID
source_contact	object	Receiving this object requires permission
source_contact.uid	string
source_contact.first_name	string
source_contact.last_name	string
source_contact.email	string
source	object	Receiving this object requires permission
source.uid	string
source.name	string
source.type	string
time_created	string	Format: `YYYY-MM-DDTHH:mm:ssZ`
URL	string	URL of the lead profile in Recruit
status	string	One of the following: `In progress` `On hold` `Rejected` `Not interested`
outreach_status	string	One of the following: `Not Contacted` `Contacted` `Responded`
time_last_status_changed	string	Format: `YYYY-MM-DDTHH:mm:ssZ`
resume	object	The resume object is only included when a dedicated permission is granted
resume.name	string
resume.url	string	Note that the URL to the resume file has a time limit of 15 minutes. If it expires, read the candidate object again to refresh the URL
tags	array of objects
tags[].name	string	Name of the candidate tag
disposition_reason	object	The reason for ending the hiring process. Applies for candidates with `status` of `Rejected` or `Withdrawn`
salary_expectations	string	Candidate salary expectations. Permission to read the candidate's salary expectations is required.
disposition_reason.reason	string
disposition_reason.note	string
address	object
address.country	string
address.state	string
address.zip	string
address.street_address	string
address.city	string

{
  "uid": "00.BBB",
  "person_uid": "45.G72",
  "first_name": "Jane",
  "middle_name": null,
  "last_name": "Smith",
  "email": "[email protected]",
  "phone": null,
  "mobile_phone": "052-7654321",
  "id_number": null,
  "linkedin_url": "https://www.linkedin.com/in/jane-smith",
  "deleted": false,
  "position_uid": "11.22",
  "source_contact": {
    "uid": "99.XYZ",
    "first_name": "John",
    "last_name": "Recruiter",
    "email": "[email protected]"
  },
  "source": {
    "uid": "88.ABC",
    "name": "LinkedIn",
    "type": "Social"
  },
  "time_created": "2024-06-01T09:00:00Z",
  "URL": "http://app.comeet.co/app/index.html?goto_url=/lead/5678",
  "status": "In progress",
  "outreach_status": "Not Contacted",
  "resume": {
    "name": "jane_smith_cv.pdf",
    "url": "https://comeet-xxx.amazonaws.com/lead-resume-url"
  },
  "tags": [
    {
      "name": "Strong Profile"
    }
  ],
  "disposition_reason": null,
  "salary_expectations": "90k / Annual",
  "address": {
    "country": "US",
    "state": "NY",
    "zip": "10001",
    "street_address": "45 W 34th St",
    "city": "New York"
  }
}