Check when people are busy
POST
/api/v1/mailbox/calendar/free-busyBusy periods for colleagues in start–end (at most 31 days). known: false means the server cannot see that person's calendar (usually someone outside the organization): treat it as unknown, never as free.
Errors
| Status | When |
|---|---|
401 |
No token, or the session expired or was signed out. Sign in again with POST /mailbox-auth/login. |
403 |
The account has a temporary password: until POST /security/password succeeds, every other call answers this with error_code: password_change_required. |
400 |
end must be after start, a range over 31 days, or No valid addresses. |
Request body
attendeesarray<string>requiredAddresses to check.
startstringrequiredISO 8601.
endstringrequiredISO 8601, at most 31 days after
start.
Request
POST
/api/v1/mailbox/calendar/free-busycurl -X POST 'https://courier.mailyte.com/api/v1/mailbox/calendar/free-busy' \
-H 'Authorization: Bearer MAILBOX_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"attendees": [
"tunde@yourdomain.com"
],
"start": "2026-10-14T08:00:00+01:00",
"end": "2026-10-14T18:00:00+01:00"
}'const response = await fetch('https://courier.mailyte.com/api/v1/mailbox/calendar/free-busy', {
method: 'POST',
headers: {
Authorization: 'Bearer MAILBOX_TOKEN',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"attendees": [
"tunde@yourdomain.com"
],
"start": "2026-10-14T08:00:00+01:00",
"end": "2026-10-14T18:00:00+01:00"
}),
});
const { data } = await response.json();import requests
response = requests.post(
"https://courier.mailyte.com/api/v1/mailbox/calendar/free-busy",
headers={"Authorization": "Bearer MAILBOX_TOKEN"},
json={
"attendees": [
"tunde@yourdomain.com"
],
"start": "2026-10-14T08:00:00+01:00",
"end": "2026-10-14T18:00:00+01:00"
},
)
data = response.json()["data"]<?php
$response = Http::withToken('MAILBOX_TOKEN')
->post('https://courier.mailyte.com/api/v1/mailbox/calendar/free-busy', [
'attendees' => [
'tunde@yourdomain.com',
],
'start' => '2026-10-14T08:00:00+01:00',
'end' => '2026-10-14T18:00:00+01:00',
]);
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://courier.mailyte.com/api/v1/mailbox/calendar/free-busy")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer MAILBOX_TOKEN"
request["Content-Type"] = "application/json"
request.body = {
"attendees": [
"tunde@yourdomain.com"
],
"start": "2026-10-14T08:00:00+01:00",
"end": "2026-10-14T18:00:00+01:00"
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }Response
Successful Response
dataarray<object>emailstringknownbooleanbusyarray<object>startstringendstring
200
application/json{
"type": "success",
"msg": "Availability retrieved successfully",
"data": [
{
"email": "tunde@yourdomain.com",
"known": true,
"busy": [
{
"start": "2026-10-14T10:00:00+01:00",
"end": "2026-10-14T11:00:00+01:00"
}
]
}
]
}Returned inside the standard envelope.
Errors
| Status | When |
|---|---|
400 | `end must be after start`, a range over 31 days, or `No valid addresses`. |
401 | No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`. |
403 | The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`. |
422 | Validation Error |
Every status, with what causes it and what to do, is on the error reference.