Get candidate availability
This API is to listing availability of candidates based on given filter. This is an authendicated API so we need to pass bearer token in request header to access the data.
Headers
-
application/json
-
application/json
Body
-
start_date string(date)
-
end_date string(date)
-
region integer
-
job integer
-
candidate integer
-
status array[string]
Values are
U
,E
,L
,LD
,N
, orOther
. -
availabilitystatus string
Values are
submitted
ornot_submitted
.
POST
/candidate/availablity
curl \
-X POST https://api-console.logezy.co/v1/candidate/availablity \
-H "Accept: string" \
-H "Content-Type: string" \
-d '{"start_date":"2025-05-04","end_date":"2025-05-04","region":42,"job":42,"candidate":42,"status":["U"],"availabilitystatus":"submitted"}'
Request examples
# Headers
Accept: string
Content-Type: string
# Payload
{
"start_date": "2025-05-04",
"end_date": "2025-05-04",
"region": 42,
"job": 42,
"candidate": 42,
"status": [
"U"
],
"availabilitystatus": "submitted"
}
Response examples (200)
{
"data": {
"to": 1,
"data": [
{
"id": 100000,
"full_name": "Saravana Developer",
"availabilities": [
{
"id": 111111,
"date": "2024-05-03",
"notes": null,
"created": null,
"shift_id": 1,
"created_at": "2024-01-30 05:30:06",
"created_by": null,
"updated_at": "2024-01-30 05:30:06",
"availability": "E",
"candidate_id": 100000
}
]
}
],
"from": 1,
"path": "http://api-console.localhost:8000/v1/candidate/availablity",
"total": 1,
"per_page": 40,
"last_page": 1,
"current_page": 1,
"last_page_url": "http://api-console.localhost:8000/v1/candidate/availablity?page=1",
"next_page_url": null,
"prev_page_url": null,
"first_page_url": "http://api-console.localhost:8000/v1/candidate/availablity?page=1"
},
"status": "success",
"message": "Candidate Availability retrieved successfully."
}