Candidate Schema

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

Field	Type	Description
uid	string	Candidate UID
person_uid	string	The candidate's person UID. Each person can have multiple candidate objects associated with it. Each candidate 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 candidate has been deleted. When `true` the candidate 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 candidate profile in Recruit
completed_steps[]	array of candidate steps
current_steps[]	array of candidate steps	If the candidate is `In progress` then this is the array of the current steps that the candidate is waiting for. If the candidate is in any other status then the array is empty.
future_steps[]	array of candidate steps
status	string	One of the following: `In progress` `On hold` `Awaiting Decision` `Rejected` `Withdrawn` `Hired`
prospect_status	string	One of the following: `Sourced` `Contacted` `Responded` `Interested` `Not interested` `Do not contact`
opening	object	This object is included when the candidate's status is `Hired`. This object includes the details of the opening for which the candidate was hired
opening.uid	string	Hired candidate's opening UID
opening.time_start_to_work	timestamp	The start date for the Hired candidate. Format: `YYYY-MM-DDTHH:mm:ssZ`
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.AAA",
  "person_uid": "45.F61",
  "first_name": "Dave",
  "middle_name": null,
  "last_name": "Mathew",
  "email": "[email protected]",
  "phone": null,
  "mobile_phone": "051-9999999",
  "id_number": null,
  "tags": [
    {  
      "name": "Ambitious"
    }
    //...
  ],
  "disposition_reason": {
    "reason": "More qualified candidate selected",
    "notes": "Chose to proceed with more qualified specialists"
  },
  "linkedin_url": null,
  "deleted": false,
  "position_uid": "11.11",
  "time_created": "2018-01-01T12:50:50Z",
  "time_last_status_changed": "2018-01-01T12:50:50Z",
  "URL": "http://app.comeet.co/app/index.html?goto_url=/can/1234",
  "current_steps": [  
    {  
      "name": "Technical interview",
      "type": "In person Interview",
      "position_step_uid": "11.CCC",
      "time_scheduled": "2018-01-01T12:50:50Z"
    }
    //...
  ],
  "completed_steps": [  
    {  
      "name": "CV Screen",
      "type": "Go/No-go",
      "position_step_uid": "10.ABC",      
      "time_scheduled": "2018-01-01T12:50:50Z",
      "time_completed": "2018-01-01T14:50:50Z"
    }
    //...
  ],
  "status": "In progress",
  "resume": {  
    "name":"michael_rosen_cv.docx",
    "url":"https://comeet-xxx.amazonaws.com/65c0a9ff2166g"
  },
  "address":{
    "country": "US",
    "state": "NY",
    "zip": "11249",
    "street_address": "109 S 5th St",
    "city": "Brooklyn"
  }    
}

Candidate step object

Field	Type	Description
name	string
type	string	One of the following: `Go/No-go` `Phone Interview` `Video Interview` `In person Interview` `Administrative` `Assessment` `Offer`
position_step_uid	string	The UID of the position step from which the step is inherited. If the step is not inherited from a position step then the value is `null`
time_scheduled	string	Format: `YYYY-MM-DDTHH:mm:ssZ`
time_completed	string	This property is included for completed steps only. Format: `YYYY-MM-DDTHH:mm:ssZ`
assignees	array of objects	The users who are assigned to complete the step. This property requires permission.
assignees[].first_name	string
assignees[].last_name	string
assignees[].email	string