Retrieve a Candidate

Request

GET https://api.comeet.co/candidates/{uid}

Request path parameters:

Name	Type	Optional	Description
uid	string	Required	UID of the candidate requested.

Request query parameters:

Name	Type	Optional	Description
include	Array of strings	Optional	Which optional fields to include in the response. See the Candidate schema for details.

Request headers:

Add the header IDENTIFIER_TYPE: REAL_ID to request a candidate object using the candidate ID as seen in the candidate's URL in Comeet instead of the UID that is used by the API.

Response

{  
  "uid": "00.AAA",
  "position_uid": "11.11",
  "time_created": "2018-01-01T12:50:50Z",
  "time_last_status_changed": "2018-01-01T12:50:50Z",
  "current_steps": [  
    {  
      "name": "Technical interview",
      "type": "In person Interview",
      "time_scheduled": "2018-01-01T12:50:50Z"
    }
    //...
  ],
  "completed_steps": [  
    {  
      "name": "CV Screen",
      "type": "Go/No-go",
      "time_scheduled": "2018-01-01T12:50:50Z",
      "time_completed": "2018-03-03T12:50:50Z"
    }
    //...
  ],
  "status": "In progress"
}

{
    "status": 401,
    "message": "You are trying to access a candidate that was removed since it was a duplicate of another candidate",
    "error": "duplicate_candidate"
}