API
Candidate API
Get Open to Work

Get Candidate's Open To Work Status

This endpoint fetches a candidate's "Open To Work" status from their LinkedIn profile.

Endpoint

 POST https://api.ezyhire.com/candidate/getOpenToWork

Request

Headers
USER-Key: User/API key for authentication
Body Json
{
  "email": "candidate@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "linkedinUrl": "https://www.linkedin.com/in/candidateprofile"
}

Response

Successful Response
Status Code: 200 OK
Content:json
{
 "status": 200,
 "message": "Candidate saved",
 "data": {
   "candidateData": {
     "email": "candidate@example.com",
     "firstName": "John",
     "lastName": "Doe",
     "openToWork": true, 
     "linkedinData": "<LinkedIn profile data>"
   },
   "totalUsages": 5,
   "currentCycleUsages": 2
 }
}
Error Response
Status Code: 401 Unauthorized or 500 Internal Server Error
Content:json
{
  "status": 401,
  "message": "Invalid User/API key",
  "error": "Please provide a valid User/API key"
}