List events in a time range
GET
/api/v1/mailbox/calendars/{calendar}/eventsEvents overlapping start–end (ISO 8601, at most 400 days apart). Repeating events come back once per occurrence in the range.
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 400 days, or an invalid time zone. |
404 |
No calendar by that name. |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
calendarrequired | path | string | |
startrequired | query | string | ISO 8601, inclusive |
endrequired | query | string | ISO 8601, exclusive |
Request
GET
/api/v1/mailbox/calendars/{calendar}/eventscurl -X GET 'https://courier.mailyte.com/api/v1/mailbox/calendars/01JBT8XQ2M9WYC3K4F6R7S8T9V/events' \
-H 'Authorization: Bearer MAILBOX_TOKEN'const response = await fetch('https://courier.mailyte.com/api/v1/mailbox/calendars/01JBT8XQ2M9WYC3K4F6R7S8T9V/events', {
method: 'GET',
headers: {
Authorization: 'Bearer MAILBOX_TOKEN',
},
});
const { data } = await response.json();import requests
response = requests.get(
"https://courier.mailyte.com/api/v1/mailbox/calendars/01JBT8XQ2M9WYC3K4F6R7S8T9V/events",
headers={"Authorization": "Bearer MAILBOX_TOKEN"},
)
data = response.json()["data"]<?php
$response = Http::withToken('MAILBOX_TOKEN')
->get('https://courier.mailyte.com/api/v1/mailbox/calendars/01JBT8XQ2M9WYC3K4F6R7S8T9V/events');
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://courier.mailyte.com/api/v1/mailbox/calendars/01JBT8XQ2M9WYC3K4F6R7S8T9V/events")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer MAILBOX_TOKEN"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }Response
Successful Response
dataarray<object>idstringThe event's id within its calendar; use it in the event URLs.
etagstringSend it back as
etagwhen you update or delete, so a change made elsewhere is not overwritten.calendarstringuidstringsummarystring or nulldescriptionstring or nulllocationstring or nullstatusstring or nullstartstringISO 8601.
endstring or nulltimezonestring or nullall_daybooleanrecurringbooleanrrulestring or nullsequenceintegerorganizerobjectemailstringnamestring or null
attendeesarray<object>emailstringnamestring or nullstatusstringrolestringrsvpbooleanschedule_statusstring or null
alarmsintegerremindersarray<integer>Minutes before the start.
200
application/json{
"type": "success",
"msg": "Events retrieved successfully",
"data": [
{
"id": "8f14e45f.ics",
"etag": "\"a1b2c3\"",
"calendar": "default",
"uid": "8f14e45f@yourdomain.com",
"summary": "Quarterly review",
"description": "Q3 numbers and the plan for Q4.",
"location": "Board room",
"status": "CONFIRMED",
"start": "2026-10-14T10:00:00+01:00",
"end": "2026-10-14T11:00:00+01:00",
"timezone": "Africa/Lagos",
"all_day": false,
"recurring": false,
"rrule": null,
"sequence": 0,
"organizer": {
"email": "ada@yourdomain.com",
"name": "Ada Obi"
},
"attendees": [
{
"email": "tunde@example.com",
"name": "Tunde Bello",
"status": "NEEDS-ACTION",
"role": "REQ-PARTICIPANT",
"rsvp": true,
"schedule_status": null
}
],
"alarms": 1,
"reminders": [
15
]
}
]
}Returned inside the standard envelope.
Errors
| Status | When |
|---|---|
400 | `end must be after start`, a range over 400 days, or an invalid time zone. |
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`. |
404 | No calendar by that name. |
422 | Validation Error |
Every status, with what causes it and what to do, is on the error reference.