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.

FieldTypeDescription
uidstringCandidate UID
person_uidstringThe candidate's person UID. Each person can have multiple candidate objects associated with it. Each candidate object represents a hiring process.
first_namestring
middle_namestring
last_namestring
emailstring
phonestring
mobile_phonestring
id_numberstring
linkedin_urlstring
deletedbooleanIndicates whether the candidate has been deleted. When true the candidate object will only include the uid
position_uidstringPosition UID
source_contactobjectReceiving this object requires permission
source_contact.uidstring
source_contact.first_namestring
source_contact.last_namestring
source_contact.emailstring
sourceobjectReceiving this object requires permission
source.uidstring
source.namestring
source.typestring
time_createdstringFormat: YYYY-MM-DDTHH:mm:ssZ
time_last_status_changedstringFormat: YYYY-MM-DDTHH:mm:ssZ
URLstringURL of the candidate profile in Comeet
completed_steps[]array of candidate steps
current_steps[]array of candidate stepsIf 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
statusstringOne of the following:
In progress
On hold
Awaiting Decision
Rejected
Withdrawn
Hired
prospect_statusstringOne of the following:
Sourced
Contacted
Responded
Interested
Not interested
Do not contact
time_last_status_changestringFormat: YYYY-MM-DDTHH:mm:ssZ
resumeobjectThe resume object is only included when a dedicated permission is granted
resume.namestring
resume.urlstringNote 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
addressobject
address.countrystring
address.statestring
address.zipstring
address.street_addressstring
address.citystring
{  
  "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,
  "linkedin_url": null,
  "deleted": false,
  "position_uid": "11.11",
  "time_created": "2018-01-01T12:50:50Z",
  "time_last_status_change": "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

FieldTypeDescription
namestring
typestringOne of the following:
Go/No-go
Phone Interview
Video Interview
In person Interview
Administrative
Assessment
Offer
position_step_uidstringThe 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_scheduledstringFormat: YYYY-MM-DDTHH:mm:ssZ
time_completedstringThis property is included for completed steps only.

Format: YYYY-MM-DDTHH:mm:ssZ
assigneesarray of objectsThe users who are assigned to complete the step. This property requires permission.
assignees[].first_namestring
assignees[].last_namestring
assignees[].emailstring