In this article, you can read about how to retrieve a candidate's (or multiple candidates') availability for a specific month via the Candidate Calendar API.
Get Candidate Calendar
GET
https://api.recman.io/v2/get/index.php?
scope=candidateCalendar&key={{api_key}}&
candidateId={{candidateId}}&month=3&year=2022Get the availability of a candidate, or multiple candidates, for a specific period of time. This is useful for checking when candidates have marked themselves as available (or unavailable) before offering them shifts or assignments.
PARAMS
| scope | candidateCalendar required |
| key | {{api_key}} required |
| candidateId | {{candidateId}} required, comma-separated IDs to look up multiple candidates in a single request |
| month | 3 required |
| year | 2022 required |
Each returned calendar entry contains a candidateCalendarId, the candidateId it belongs to, the date, a fromTime/toTime window, a status (e.g. available), and optional notes.