Events API

List Events

Retrieves calendar events from all connected providers (Google Calendar, Microsoft Outlook, Apple Calendar, CalDAV) for the authenticated user.

Fetches events from multiple calendar providers simultaneously with support for pagination, filtering by date range and specific calendars, and handling of recurring events. Returns chronologically sorted events across all providers with "load more" functionality using nextPageToken tokens.

Endpoint: GET /events

Request Parameters

pageSizenumber

Number of events to fetch per request. Maximum value is capped at 1000.

Default: 250

startstring

ISO date string to filter events starting from this date. Date strings are automatically normalized to handle malformed ISO 8601 formats.

Default: First day of the current month at 00:00:00 UTC

endstring

ISO date string to filter events ending before this date. Date strings are automatically normalized to handle malformed ISO 8601 formats.

Default: Last day of the current month at 23:59:59 UTC

calendarIdsstring

JSON stringified object of calendar IDs per provider. If not provided, events from all calendars will be fetched.

Calendar IDs that are not associated with the authenticated user's connected accounts will be silently ignored.

Example
'{"google":["john.andrew@mobiscroll.com"],"microsoft":[],"apple":[],"caldav":[]}'

Default: undefined

nextPageTokenstring

Base64 encoded JSON pagination state object containing token information for each provider (Google, Microsoft, Apple, CalDAV). This parameter should be passed as-is from the previous response when loading more events.

Default: undefined

singleEventsboolean

Controls how recurring events are returned:

true - Expands recurring events into individual instances within the specified time range
false - Returns only the master recurring event (series definition) without individual occurrences

Default: true

Response

eventsArray<CalendarEvent>

Array of calendar events from all providers, sorted chronologically by start time. Each CalendarEvent object contains:

providerstring

Provider name: 'google', 'microsoft', 'apple', or 'caldav'

idstring

Event ID

calendarIdstring

Calendar ID

titlestring

Event title/summary

descriptionstring

Event description or notes (optional)

startDate

Event start date/time

endDate

Event end date/time

allDayboolean

True if all-day event

recurringEventIdstring

ID of the recurring event series (if this is an instance of a recurring event) (optional)

colorstring

Event background color (optional)

locationstring

Event location (optional)

attendeesArray<EventAttendee>

Array of event attendees (optional). Each object contains:

emailstring

Attendee email address

statusstring

Response status: 'accepted', 'declined', 'tentative', or 'none'

organizerboolean

True if this attendee is the event organizer (optional)

customobject

Custom key-value pairs for additional event data (optional)

conferencestring

Conference meeting URL (optional).

conferenceDataobject

Provider-specific conference metadata returned by the API (optional). Use this when you need details beyond the conference link.

providerstring

Conference provider identifier. Typical values: google-meet, microsoft-teams, zoom, webex.

Additional fields vary by provider and are returned as-is when available. Typical examples:

Google: entryPoints, conferenceSolution, conferenceId
Microsoft: provider meeting details from Graph (for example join URL-related fields)
Apple/CalDAV: usually only provider

availabilitystring

Event availability: 'busy' or 'free' (optional)

privacystring

Event privacy: 'public', 'private', or 'confidential' (optional)

statusstring

Event status: 'confirmed', 'tentative', or 'cancelled' (optional)

lastModifiedstring

ISO 8601 timestamp of when the event was last modified (optional)

linkstring

Public event link (optional)

originalobject

Original event object from the provider

pageSizenumber

Number of events per page.

nextPageTokenstring

Base64 encoded pagination state for the next request. Pass this value as the nextPageToken parameter when loading more events. Only included in the response if more events are available.

Error Responses

400 - Bad Request. Invalid nextPageToken parameters
401 - Unauthorized. Invalid or missing bearer token
500 - Internal Server Error. Provider error or unexpected failure

Examples

Fetch initial events with date range filter
GET /events?pageSize=50&start=2025-10-01T00:00:00Z&end=2025-10-31T23:59:59Z

Response
{
  "events": [
    {
      "id": "event123",
      "title": "Team Meeting",
      "start": "2025-10-15T10:00:00Z",
      "end": "2025-10-15T11:00:00Z",
      "provider": "google",
      "allDay": false,
      "location": "Conference Room A",
      "color": "#9fc6e7",
      "lastModified": "2026-03-10T13:36:08.000Z"
    }
  ],
  "pageSize": 50,
  "nextPageToken": "eyJnb29nbGUiOnsidG9rZW4iOnsiY2FsMTIzIjp7Im5leHRQYWdlVG9rZW4iOiJhYmMifX0sImlzRGVwbGV0ZWQiOmZhbHNlfX0="
}

Load more events using nextPageToken
GET /events?pageSize=50&nextPageToken=eyJnb29nbGUiOnsidG9rZW4iOnsiY2FsMTIzIjp7Im5leHRQYWdlVG9rZW4iOiJhYmMifX0sImlzRGVwbGV0ZWQiOmZhbHNlfX0=

Filter by specific calendars
GET /events?pageSize=25&calendarIds=%7B%22google%22:%5B%22john.andrew%40mobiscroll.com%22%5D,%22microsoft%22:%5B%5D,%22apple%22:%5B%5D,%22caldav%22:%5B%5D%7D

Get recurring event series masters (not expanded)
GET /events?pageSize=50&singleEvents=false

// Fetch initial events with date range filter
const response = await client.events.list({
  pageSize: 50,
  start: '2025-10-01T00:00:00Z',
  end: '2025-10-31T23:59:59Z'
});
console.log(response.events);

// Load more events using nextPageToken
const nextResponse = await client.events.list({
  pageSize: 50,
  nextPageToken: response.nextPageToken
});

// Filter by specific calendars
const filteredEvents = await client.events.list({
  pageSize: 25,
  calendarIds: ['personal@gmail.com', 'work@company.com']
});

// Get recurring event series masters (not expanded)
const masters = await client.events.list({
  pageSize: 50,
  singleEvents: false
});

# Fetch initial events with date range filter
response = client.events.list(
    page_size=50,
    start='2025-10-01T00:00:00Z',
    end='2025-10-31T23:59:59Z',
)

# Load more events using next_page_token
next_response = client.events.list(
    page_size=50,
    next_page_token=response.next_page_token,
)

# Filter by specific calendars
filtered_events = client.events.list(
    page_size=25,
    calendar_ids={'google': ['personal@gmail.com', 'work@company.com']},
)

# Get recurring event series masters (not expanded)
masters = client.events.list(
    page_size=50,
    single_events=False,
)

// Fetch initial events with date range filter
$response = $client->events()->list([
    'pageSize' => 50,
    'start' => '2025-10-01T00:00:00Z',
    'end' => '2025-10-31T23:59:59Z',
]);
$events = $response['events'];

// Load more events using nextPageToken
$nextResponse = $client->events()->list([
    'pageSize' => 50,
    'nextPageToken' => $response['nextPageToken'],
]);

// Filter by specific calendars
$filteredEvents = $client->events()->list([
    'pageSize' => 25,
    'calendarIds' => ['google' => ['personal@gmail.com', 'work@company.com']],
]);

// Get recurring event series masters (not expanded)
$masters = $client->events()->list([
    'pageSize' => 50,
    'singleEvents' => false,
]);

// Fetch initial events with date range filter
var response = await client.Events.ListAsync(new EventListParams
{
    PageSize = 50,
    Start = DateTime.Parse("2025-10-01T00:00:00Z"),
    End = DateTime.Parse("2025-10-31T23:59:59Z"),
});

// Load more events using nextPageToken
var nextResponse = await client.Events.ListAsync(new EventListParams
{
    PageSize = 50,
    NextPageToken = response.NextPageToken,
});

// Filter by specific calendars
var filteredEvents = await client.Events.ListAsync(new EventListParams
{
    PageSize = 25,
    CalendarIds = new Dictionary<string, List<string>>
    {
        { "google", new List<string> { "personal@gmail.com", "work@company.com" } }
    },
});

// Get recurring event series masters (not expanded)
var masters = await client.Events.ListAsync(new EventListParams
{
    PageSize = 50,
    SingleEvents = false,
});

import com.mobiscroll.connect.Provider;
import com.mobiscroll.connect.models.EventListParams;
import com.mobiscroll.connect.models.EventsListResponse;
import java.time.OffsetDateTime;
import java.util.List;
import java.util.Map;

// Fetch initial events with date range filter
EventsListResponse response = client.events().list(EventListParams.builder()
    .pageSize(50)
    .start(OffsetDateTime.parse("2025-10-01T00:00:00Z"))
    .end(OffsetDateTime.parse("2025-10-31T23:59:59Z"))
    .build());

// Load more events using nextPageToken
EventsListResponse nextResponse = client.events().list(EventListParams.builder()
    .pageSize(50)
    .nextPageToken(response.getNextPageToken())
    .build());

// Filter by specific calendars
EventsListResponse filtered = client.events().list(EventListParams.builder()
    .pageSize(25)
    .calendarIds(Map.of(
        Provider.GOOGLE, List.of("personal@gmail.com", "work@company.com")
    ))
    .build());

// Get recurring event series masters (not expanded)
EventsListResponse masters = client.events().list(EventListParams.builder()
    .pageSize(50)
    .singleEvents(false)
    .build());

import (
    "time"

    mobiscroll "github.com/acidb/mobiscroll-connect-sdks/sdks/go"
)

start, _ := time.Parse(time.RFC3339, "2025-10-01T00:00:00Z")
end, _ := time.Parse(time.RFC3339, "2025-10-31T23:59:59Z")

// Fetch initial events with date range filter
response, err := client.Events().List(ctx, &mobiscroll.EventListParams{
    PageSize: mobiscroll.Ptr(50),
    Start:    &start,
    End:      &end,
})

// Load more events using NextPageToken
nextResponse, err := client.Events().List(ctx, &mobiscroll.EventListParams{
    PageSize:      mobiscroll.Ptr(50),
    NextPageToken: response.NextPageToken,
})

// Filter by specific calendars
filtered, err := client.Events().List(ctx, &mobiscroll.EventListParams{
    PageSize: mobiscroll.Ptr(25),
    CalendarIDs: map[mobiscroll.Provider][]string{
        mobiscroll.ProviderGoogle: {"personal@gmail.com", "work@company.com"},
    },
})

// Get recurring event series masters (not expanded)
masters, err := client.Events().List(ctx, &mobiscroll.EventListParams{
    PageSize:     mobiscroll.Ptr(50),
    SingleEvents: mobiscroll.Ptr(false),
})

# Fetch initial events with date range filter
response = client.events.list(
  page_size: 50,
  start:     '2025-10-01T00:00:00Z',
  end:       '2025-10-31T23:59:59Z'
)

# Load more events using next_page_token
next_response = client.events.list(
  page_size:       50,
  next_page_token: response.next_page_token
)

# Filter by specific calendars
filtered = client.events.list(
  page_size:    25,
  calendar_ids: {
    Mobiscroll::Connect::Provider::GOOGLE => ['personal@gmail.com', 'work@company.com']
  }
)

# Get recurring event series masters (not expanded)
masters = client.events.list(
  page_size:     50,
  single_events: false
)

info

Events are sorted chronologically by start time across all providers
The pageSize is distributed across all active providers (not per provider)
Maximum pageSize is capped at 1000 events
The nextPageToken token is Base64 encoded and should be passed as-is to subsequent requests
Each provider (Google, Microsoft, Apple, CalDAV) tracks its own pagination state independently
The nextPageToken parameter is only included in the response when more events are available
Date strings are automatically normalized to handle malformed ISO 8601 formats before parsing
The color property contains the background color value directly (not an object)
Conference links are returned in the conference string field
All event endpoints return events in the unified CalendarEvent format across all providers

Conference raw data examples

The conferenceData field stores provider-specific raw meeting metadata.

Google
{
  "conferenceData": {
    "conferenceId": "abc-defg-hij",
    "entryPoints": [
      {
        "entryPointType": "video",
        "uri": "https://meet.google.com/abc-defg-hij"
      }
    ]
  }
}

Microsoft
{
  "onlineMeeting": {
    "joinUrl": "https://teams.microsoft.com/l/meetup-join/...",
    "conferenceId": "123456789"
  }
}

Create Event

Creates a new calendar event in the specified calendar for the authenticated user.

Supports creating single events or recurring events with recurrence rules. The event is created in the provider's calendar system (Google Calendar, Microsoft Outlook, Apple Calendar, or CalDAV) based on the calendar ID.

Endpoint: POST /event

Request Body

providerstringRequired

Calendar provider where the event will be created. One of: 'google', 'microsoft', 'apple', or 'caldav'.

calendarIdstringRequired

The calendar identifier where the event will be created.

titlestringRequired

The event title/summary.

startstringRequired

ISO date string for the event start time.

endstringRequired

ISO date string for the event end time.

descriptionstring

Event description or notes.

Default: undefined

locationstring

Event location (address, meeting room, etc.).

Default: undefined

allDayboolean

Whether this is an all-day event.

Default: false

attendeesstring[]

Array of attendee email addresses.

Default: undefined

recurrenceobject

Recurrence rule for creating a recurring event series. Object with the following properties:

frequencystringRequired

Recurrence frequency: 'DAILY', 'WEEKLY', 'MONTHLY', or 'YEARLY'

intervalnumber

Interval between occurrences (e.g., 2 for every 2 weeks)

countnumber

Number of occurrences (mutually exclusive with until)

untilstring

End date in format YYYYMMDDTHHMMSSZ (mutually exclusive with count)

byDaystring[]

Array of weekday codes: ['MO', 'TU', 'WE', 'TH', 'FR', 'SA', 'SU']

byMonthDaynumber[]

Array of days of the month (1-31)

byMonthnumber[]

Array of months (1-12)

Default: undefined

customobject

Custom key-value pairs for additional event data.

Default: undefined

External IDs

If you need to associate provider-generated event IDs with your own domain entities, store your external/business ID in custom (for example custom.externalEventId = "icoll-rdv-123").

conferencestring

Conference meeting URL (optional). Backward compatibility is preserved for legacy conference string usage.

Default: undefined

conferenceDataobject

Extra conference options and provider-specific metadata (optional).

providerstring

Conference provider identifier. Typical values: google-meet, microsoft-teams, zoom, webex.

autoGenerateboolean

Set to true to auto-generate a provider meeting link when supported. When autoGenerate is true, conference and other conferenceData fields are ignored.

Default: undefined

availabilitystring

Event availability: 'free' or 'busy'.

Default: undefined

privacystring

Event privacy: 'public', 'private', or 'confidential'.

Default: undefined

statusstring

Event status: 'confirmed', 'tentative', or 'cancelled'.

Default: undefined

Response

successboolean

Indicates whether the event was created successfully.

idstring

The event ID.

titlestring

The event title.

startDate

The event start date/time.

endDate

The event end date/time.

messagestring

Error or status message (included on failure).

info

The response includes all properties of the created CalendarEvent object merged at the root level.

Error Responses

400 - Bad Request. Invalid event data or missing required fields
401 - Unauthorized. Invalid or missing bearer token
404 - Not Found. Calendar not found
500 - Internal Server Error. Provider error or unexpected failure

Examples

Create a simple event
POST /event
Content-Type: application/json

{
  "provider": "google",
  "calendarId": "primary",
  "title": "Team Meeting",
  "description": "Discuss project updates",
  "start": "2025-11-01T10:00:00Z",
  "end": "2025-11-01T11:00:00Z",
  "location": "Conference Room A",
  "conference": {
    "url": "https://meet.google.com/abc-defg-hij",
    "provider": "google-meet"
  }
}

Response
{
  "success": true,
  "provider": "google",
  "id": "event123abc",
  "title": "Team Meeting",
  "start": "2025-11-01T10:00:00.000Z",
  "end": "2025-11-01T11:00:00.000Z",
  "allDay": false,
  "location": "Conference Room A",
  "conference": {
    "url": "https://meet.google.com/abc-defg-hij",
    "provider": "google-meet"
  },
  "attendees": [],
  "color": "#9fc6e7",
  "availability": "busy",
  "privacy": "public",
  "status": "confirmed",
  "lastModified": "2026-03-10T13:36:08.000Z",
  "link": "https://calendar.google.com/calendar/event?eid=...",
  "original": {
    "kind": "calendar#event",
    "etag": "\"3366428166344000\"",
    "id": "event123abc",
    "summary": "Team Meeting"
    ...
  }
}

Create a recurring event
POST /event
Content-Type: application/json

{
  "provider": "microsoft",
  "calendarId": "AAMkAGVmMDEz...",
  "title": "Weekly Standup",
  "start": "2025-11-01T09:00:00Z",
  "end": "2025-11-01T09:30:00Z",
  "allDay": false,
  "recurrence": {
    "frequency": "WEEKLY",
    "interval": 1,
    "count": 10,
    "byDay": ["MO", "WE", "FR"]
  }
}

Create an all-day event
POST /event
Content-Type: application/json

{
  "provider": "apple",
  "calendarId": "https://caldav.icloud.com/.../calendars/...",
  "title": "Conference",
  "start": "2025-11-15T00:00:00Z",
  "end": "2025-11-16T00:00:00Z",
  "allDay": true,
  "description": "Annual tech conference"
}

// Create a simple event
const event = await client.events.create({
  provider: 'google',
  calendarId: 'primary',
  title: 'Team Meeting',
  description: 'Discuss project updates',
  start: '2025-11-01T10:00:00Z',
  end: '2025-11-01T11:00:00Z',
  location: 'Conference Room A',
  conference: {
    url: 'https://meet.google.com/abc-defg-hij',
    provider: 'google-meet'
  }
});

// Create a recurring event
const recurringEvent = await client.events.create({
  provider: 'microsoft',
  calendarId: 'AAMkAGVmMDEz...',
  title: 'Weekly Standup',
  start: '2025-11-01T09:00:00Z',
  end: '2025-11-01T09:30:00Z',
  allDay: false,
  recurrence: {
    frequency: 'WEEKLY',
    interval: 1,
    count: 10,
    byDay: ['MO', 'WE', 'FR']
  }
});

// Create an all-day event
const allDayEvent = await client.events.create({
  provider: 'apple',
  calendarId: 'https://caldav.icloud.com/.../calendars/...',
  title: 'Conference',
  start: '2025-11-15T00:00:00Z',
  end: '2025-11-16T00:00:00Z',
  allDay: true,
  description: 'Annual tech conference'
});

# Create a simple event
event = client.events.create({
    'provider': 'google',
    'calendarId': 'primary',
    'title': 'Team Meeting',
    'description': 'Discuss project updates',
    'start': '2025-11-01T10:00:00Z',
    'end': '2025-11-01T11:00:00Z',
    'location': 'Conference Room A',
})

# Create a recurring event
recurring_event = client.events.create({
    'provider': 'microsoft',
    'calendarId': 'AAMkAGVmMDEz...',
    'title': 'Weekly Standup',
    'start': '2025-11-01T09:00:00Z',
    'end': '2025-11-01T09:30:00Z',
    'allDay': False,
    'recurrence': {
        'frequency': 'WEEKLY',
        'interval': 1,
        'count': 10,
        'byDay': ['MO', 'WE', 'FR'],
    },
})

# Create an all-day event
all_day_event = client.events.create({
    'provider': 'apple',
    'calendarId': 'https://caldav.icloud.com/.../calendars/...',
    'title': 'Conference',
    'start': '2025-11-15T00:00:00Z',
    'end': '2025-11-16T00:00:00Z',
    'allDay': True,
    'description': 'Annual tech conference',
})

// Create a simple event
$event = $client->events()->create([
    'provider' => 'google',
    'calendarId' => 'primary',
    'title' => 'Team Meeting',
    'description' => 'Discuss project updates',
    'start' => '2025-11-01T10:00:00Z',
    'end' => '2025-11-01T11:00:00Z',
    'location' => 'Conference Room A',
]);

// Create a recurring event
$recurringEvent = $client->events()->create([
    'provider' => 'microsoft',
    'calendarId' => 'AAMkAGVmMDEz...',
    'title' => 'Weekly Standup',
    'start' => '2025-11-01T09:00:00Z',
    'end' => '2025-11-01T09:30:00Z',
    'allDay' => false,
]);

// Create an all-day event
$allDayEvent = $client->events()->create([
    'provider' => 'apple',
    'calendarId' => 'https://caldav.icloud.com/.../calendars/...',
    'title' => 'Conference',
    'start' => '2025-11-15T00:00:00Z',
    'end' => '2025-11-16T00:00:00Z',
    'allDay' => true,
    'description' => 'Annual tech conference',
]);

// Create a simple event
var event = await client.Events.CreateAsync(new CreateEventParams
{
    Provider = "google",
    CalendarId = "primary",
    Title = "Team Meeting",
    Description = "Discuss project updates",
    Start = DateTime.Parse("2025-11-01T10:00:00Z"),
    End = DateTime.Parse("2025-11-01T11:00:00Z"),
    Location = "Conference Room A",
});

// Create a recurring event
var recurringEvent = await client.Events.CreateAsync(new CreateEventParams
{
    Provider = "microsoft",
    CalendarId = "AAMkAGVmMDEz...",
    Title = "Weekly Standup",
    Start = DateTime.Parse("2025-11-01T09:00:00Z"),
    End = DateTime.Parse("2025-11-01T09:30:00Z"),
    AllDay = false,
    Recurrence = new RecurrenceRule
    {
        Frequency = "WEEKLY",
        Interval = 1,
        Count = 10,
        ByDay = new[] { "MO", "WE", "FR" },
    },
});

// Create an all-day event
var allDayEvent = await client.Events.CreateAsync(new CreateEventParams
{
    Provider = "apple",
    CalendarId = "https://caldav.icloud.com/.../calendars/...",
    Title = "Conference",
    Start = DateTime.Parse("2025-11-15T00:00:00Z"),
    End = DateTime.Parse("2025-11-16T00:00:00Z"),
    AllDay = true,
    Description = "Annual tech conference",
});

import com.mobiscroll.connect.Provider;
import com.mobiscroll.connect.models.CalendarEvent;
import com.mobiscroll.connect.models.EventCreateData;
import com.mobiscroll.connect.models.RecurrenceRule;
import java.time.OffsetDateTime;
import java.util.List;

// Create a simple event
CalendarEvent event = client.events().create(EventCreateData.builder()
    .provider(Provider.GOOGLE)
    .calendarId("primary")
    .title("Team Meeting")
    .description("Discuss project updates")
    .start(OffsetDateTime.parse("2025-11-01T10:00:00Z"))
    .end(OffsetDateTime.parse("2025-11-01T11:00:00Z"))
    .location("Conference Room A")
    .build());

// Create a recurring event
CalendarEvent recurringEvent = client.events().create(EventCreateData.builder()
    .provider(Provider.MICROSOFT)
    .calendarId("AAMkAGVmMDEz...")
    .title("Weekly Standup")
    .start(OffsetDateTime.parse("2025-11-01T09:00:00Z"))
    .end(OffsetDateTime.parse("2025-11-01T09:30:00Z"))
    .allDay(false)
    .recurrence(RecurrenceRule.builder()
        .frequency("WEEKLY")
        .interval(1)
        .count(10)
        .byDay(List.of("MO", "WE", "FR"))
        .build())
    .build());

// Create an all-day event
CalendarEvent allDayEvent = client.events().create(EventCreateData.builder()
    .provider(Provider.APPLE)
    .calendarId("https://caldav.icloud.com/.../calendars/...")
    .title("Conference")
    .start(OffsetDateTime.parse("2025-11-15T00:00:00Z"))
    .end(OffsetDateTime.parse("2025-11-16T00:00:00Z"))
    .allDay(true)
    .description("Annual tech conference")
    .build());

import (
    "time"

    mobiscroll "github.com/acidb/mobiscroll-connect-sdks/sdks/go"
)

start, _ := time.Parse(time.RFC3339, "2025-11-01T10:00:00Z")
end, _ := time.Parse(time.RFC3339, "2025-11-01T11:00:00Z")

// Create a simple event
event, err := client.Events().Create(ctx, &mobiscroll.EventCreateData{
    Provider:    mobiscroll.ProviderGoogle,
    CalendarID:  "primary",
    Title:       "Team Meeting",
    Description: "Discuss project updates",
    Start:       start,
    End:         end,
    Location:    "Conference Room A",
})

// Create a recurring event
recurringStart, _ := time.Parse(time.RFC3339, "2025-11-01T09:00:00Z")
recurringEnd, _ := time.Parse(time.RFC3339, "2025-11-01T09:30:00Z")
recurringEvent, err := client.Events().Create(ctx, &mobiscroll.EventCreateData{
    Provider:   mobiscroll.ProviderMicrosoft,
    CalendarID: "AAMkAGVmMDEz...",
    Title:      "Weekly Standup",
    Start:      recurringStart,
    End:        recurringEnd,
    AllDay:     mobiscroll.Ptr(false),
    Recurrence: &mobiscroll.RecurrenceRule{
        Frequency: "WEEKLY",
        Interval:  mobiscroll.Ptr(1),
        Count:     mobiscroll.Ptr(10),
        ByDay:     []string{"MO", "WE", "FR"},
    },
})

// Create an all-day event
allDayStart, _ := time.Parse(time.RFC3339, "2025-11-15T00:00:00Z")
allDayEnd, _ := time.Parse(time.RFC3339, "2025-11-16T00:00:00Z")
allDayEvent, err := client.Events().Create(ctx, &mobiscroll.EventCreateData{
    Provider:    mobiscroll.ProviderApple,
    CalendarID:  "https://caldav.icloud.com/.../calendars/...",
    Title:       "Conference",
    Start:       allDayStart,
    End:         allDayEnd,
    AllDay:      mobiscroll.Ptr(true),
    Description: "Annual tech conference",
})

# Create a simple event
event = client.events.create(
  provider:    Mobiscroll::Connect::Provider::GOOGLE,
  calendar_id: 'primary',
  title:       'Team Meeting',
  description: 'Discuss project updates',
  start:       '2025-11-01T10:00:00Z',
  end:         '2025-11-01T11:00:00Z',
  location:    'Conference Room A'
)

# Create a recurring event
recurring_event = client.events.create(
  provider:    Mobiscroll::Connect::Provider::MICROSOFT,
  calendar_id: 'AAMkAGVmMDEz...',
  title:       'Weekly Standup',
  start:       '2025-11-01T09:00:00Z',
  end:         '2025-11-01T09:30:00Z',
  all_day:     false,
  recurrence:  Mobiscroll::Connect::RecurrenceRule.new(
    frequency: 'WEEKLY',
    interval:  1,
    count:     10,
    by_day:    %w[MO WE FR]
  )
)

# Create an all-day event
all_day_event = client.events.create(
  provider:    Mobiscroll::Connect::Provider::APPLE,
  calendar_id: 'https://caldav.icloud.com/.../calendars/...',
  title:       'Conference',
  start:       '2025-11-15T00:00:00Z',
  end:         '2025-11-16T00:00:00Z',
  all_day:     true,
  description: 'Annual tech conference'
)

info

The provider parameter must match the calendar provider of the calendarId
For recurring events, either count or until can be specified, but not both
The byDay property is typically used with WEEKLY frequency
All-day events should have start and end times at midnight (00:00:00)
The response event object format varies by provider (Google, Microsoft, Apple, CalDAV)

Update Event

Updates an existing calendar event.

Supports updating single events, recurring event series, or individual instances of recurring events. For recurring events, you can specify whether to update only the current instance, all following instances, or the entire series.

Endpoint: PUT /event

Request Body

providerstringRequired

Calendar provider where the event exists. One of: 'google', 'microsoft', 'apple', or 'caldav'.

eventIdstringRequired

The event identifier to update.

calendarIdstringRequired

The calendar identifier containing the event.

recurringEventIdstring

The ID of the recurring event series. Required when updating an instance of a recurring event.

Default: undefined

updateModestring

Controls which events in a recurring series are updated:

'this' - Update only this specific instance
'following' - Update this and all following instances
'all' - Update all instances in the series

Only applicable for recurring events. If not specified, updates the single event or series master.

Default: undefined

titlestring

The event title/summary.

startstring

ISO date string for the event start time.

endstring

ISO date string for the event end time.

descriptionstring

Event description or notes.

locationstring

Event location.

allDayboolean

Whether this is an all-day event.

attendeesstring[]

Array of attendee email addresses.

customobject

Custom key-value pairs for additional event data.

conferencestring

Conference meeting URL update (optional).

conferenceDataobject

Extra conference options and provider-specific metadata update (optional).

providerstring

Conference provider identifier. Typical values: google-meet, microsoft-teams, zoom, webex.

autoGenerateboolean

Set to true to auto-generate a provider meeting link when supported. When autoGenerate is true, conference and other conferenceData fields are ignored.

Conference update behavior by provider

google: supports conference and conferenceData.autoGenerate
microsoft: supports conferenceData.autoGenerate (Teams link generation); manual conference is ignored for online meeting generation
apple and caldav: support conference; conferenceData.autoGenerate is ignored
conferenceData.autoGenerate takes precedence over conference when both are provided
conferenceData.provider identifies the conference system (for example google-meet, microsoft-teams)

availabilitystring

Event availability: 'free' or 'busy'.

privacystring

Event privacy: 'public', 'private', or 'confidential'.

statusstring

Event status: 'confirmed', 'tentative', or 'cancelled'.

recurrenceobject

Recurrence rule for updating recurring event properties. Same structure as create recurrence.

Response

Same structure as Create Event response.

successboolean

Indicates whether the event was updated successfully.

messagestring

Error or status message (included on failure).

info

The response includes all properties of the updated CalendarEvent object merged at the root level.

Error Responses

400 - Bad Request. Invalid event data or missing required fields
401 - Unauthorized. Invalid or missing bearer token
404 - Not Found. Event or calendar not found
500 - Internal Server Error. Provider error or unexpected failure

Examples

Update a simple event
PUT /event
Content-Type: application/json

{
  "provider": "google",
  "eventId": "event123abc",
  "calendarId": "primary",
  "title": "Updated Team Meeting",
  "start": "2025-11-01T14:00:00Z",
  "end": "2025-11-01T15:00:00Z",
  "conference": {
    "url": "https://meet.google.com/new-room-link",
    "provider": "google-meet"
  }
}

Update a single instance of a recurring event
PUT /event
Content-Type: application/json

{
  "provider": "microsoft",
  "eventId": "instance456",
  "recurringEventId": "series123",
  "calendarId": "AAMkAGVmMDEz...",
  "updateMode": "this",
  "title": "Standup - Special Topic Today",
  "start": "2025-11-01T09:00:00Z",
  "end": "2025-11-01T10:00:00Z"
}

Update all future occurrences
PUT /event
Content-Type: application/json

{
  "provider": "apple",
  "eventId": "recurring-event-id",
  "calendarId": "https://caldav.icloud.com/.../calendars/...",
  "updateMode": "following",
  "location": "New Conference Room B"
}

// Update a simple event
const updatedEvent = await client.events.update({
  provider: 'google',
  calendarId: 'primary',
  eventId: 'event123abc',
  title: 'Updated Team Meeting',
  start: '2025-11-01T14:00:00Z',
  end: '2025-11-01T15:00:00Z',
  conference: {
    url: 'https://meet.google.com/new-room-link',
    provider: 'google-meet'
  }
});

// Update a single instance of a recurring event
const updatedInstance = await client.events.update({
  provider: 'microsoft',
  eventId: 'instance456',
  recurringEventId: 'series123',
  calendarId: 'AAMkAGVmMDEz...',
  updateMode: 'this',
  title: 'Standup - Special Topic Today',
  start: '2025-11-01T09:00:00Z',
  end: '2025-11-01T10:00:00Z'
});

// Update all future occurrences
const updatedFuture = await client.events.update({
  provider: 'apple',
  eventId: 'recurring-event-id',
  calendarId: 'https://caldav.icloud.com/.../calendars/...',
  updateMode: 'following',
  location: 'New Conference Room B'
});

# Update a simple event
updated_event = client.events.update({
    'provider': 'google',
    'calendarId': 'primary',
    'eventId': 'event123abc',
    'title': 'Updated Team Meeting',
    'start': '2025-11-01T14:00:00Z',
    'end': '2025-11-01T15:00:00Z',
})

# Update a single instance of a recurring event
updated_instance = client.events.update({
    'provider': 'microsoft',
    'eventId': 'instance456',
    'recurringEventId': 'series123',
    'calendarId': 'AAMkAGVmMDEz...',
    'updateMode': 'this',
    'title': 'Standup - Special Topic Today',
    'start': '2025-11-01T09:00:00Z',
    'end': '2025-11-01T10:00:00Z',
})

# Update all future occurrences
updated_future = client.events.update({
    'provider': 'apple',
    'eventId': 'recurring-event-id',
    'calendarId': 'https://caldav.icloud.com/.../calendars/...',
    'updateMode': 'following',
    'location': 'New Conference Room B',
})

// Update a simple event
$updatedEvent = $client->events()->update([
    'provider' => 'google',
    'calendarId' => 'primary',
    'eventId' => 'event123abc',
    'title' => 'Updated Team Meeting',
    'start' => '2025-11-01T14:00:00Z',
    'end' => '2025-11-01T15:00:00Z',
]);

// Update a single instance of a recurring event
$updatedInstance = $client->events()->update([
    'provider' => 'microsoft',
    'eventId' => 'instance456',
    'recurringEventId' => 'series123',
    'calendarId' => 'AAMkAGVmMDEz...',
    'title' => 'Standup - Special Topic Today',
    'start' => '2025-11-01T09:00:00Z',
    'end' => '2025-11-01T10:00:00Z',
]);

// Update all future occurrences
$updatedFuture = $client->events()->update([
    'provider' => 'apple',
    'eventId' => 'recurring-event-id',
    'calendarId' => 'https://caldav.icloud.com/.../calendars/...',
    'location' => 'New Conference Room B',
]);

// Update a simple event
var updatedEvent = await client.Events.UpdateAsync(new UpdateEventParams
{
    Provider = "google",
    CalendarId = "primary",
    EventId = "event123abc",
    Title = "Updated Team Meeting",
    Start = DateTime.Parse("2025-11-01T14:00:00Z"),
    End = DateTime.Parse("2025-11-01T15:00:00Z"),
});

// Update a single instance of a recurring event
var updatedInstance = await client.Events.UpdateAsync(new UpdateEventParams
{
    Provider = "microsoft",
    EventId = "instance456",
    RecurringEventId = "series123",
    CalendarId = "AAMkAGVmMDEz...",
    UpdateMode = "this",
    Title = "Standup - Special Topic Today",
    Start = DateTime.Parse("2025-11-01T09:00:00Z"),
    End = DateTime.Parse("2025-11-01T10:00:00Z"),
});

// Update all future occurrences
var updatedFuture = await client.Events.UpdateAsync(new UpdateEventParams
{
    Provider = "apple",
    EventId = "recurring-event-id",
    CalendarId = "https://caldav.icloud.com/.../calendars/...",
    UpdateMode = "following",
    Location = "New Conference Room B",
});

import com.mobiscroll.connect.Provider;
import com.mobiscroll.connect.models.CalendarEvent;
import com.mobiscroll.connect.models.EventUpdateData;
import java.time.OffsetDateTime;

// Update a simple event
CalendarEvent updatedEvent = client.events().update(EventUpdateData.builder()
    .provider(Provider.GOOGLE)
    .calendarId("primary")
    .eventId("event123abc")
    .title("Updated Team Meeting")
    .start(OffsetDateTime.parse("2025-11-01T14:00:00Z"))
    .end(OffsetDateTime.parse("2025-11-01T15:00:00Z"))
    .build());

// Update a single instance of a recurring event
CalendarEvent updatedInstance = client.events().update(EventUpdateData.builder()
    .provider(Provider.MICROSOFT)
    .eventId("instance456")
    .recurringEventId("series123")
    .calendarId("AAMkAGVmMDEz...")
    .updateMode("this")
    .title("Standup - Special Topic Today")
    .start(OffsetDateTime.parse("2025-11-01T09:00:00Z"))
    .end(OffsetDateTime.parse("2025-11-01T10:00:00Z"))
    .build());

// Update all future occurrences
CalendarEvent updatedFuture = client.events().update(EventUpdateData.builder()
    .provider(Provider.APPLE)
    .eventId("recurring-event-id")
    .calendarId("https://caldav.icloud.com/.../calendars/...")
    .updateMode("following")
    .location("New Conference Room B")
    .build());

import (
    "time"

    mobiscroll "github.com/acidb/mobiscroll-connect-sdks/sdks/go"
)

start, _ := time.Parse(time.RFC3339, "2025-11-01T14:00:00Z")
end, _ := time.Parse(time.RFC3339, "2025-11-01T15:00:00Z")

// Update a simple event
updatedEvent, err := client.Events().Update(ctx, &mobiscroll.EventUpdateData{
    Provider:   mobiscroll.ProviderGoogle,
    CalendarID: "primary",
    EventID:    "event123abc",
    Title:      "Updated Team Meeting",
    Start:      &start,
    End:        &end,
})

// Update a single instance of a recurring event
instanceStart, _ := time.Parse(time.RFC3339, "2025-11-01T09:00:00Z")
instanceEnd, _ := time.Parse(time.RFC3339, "2025-11-01T10:00:00Z")
updatedInstance, err := client.Events().Update(ctx, &mobiscroll.EventUpdateData{
    Provider:         mobiscroll.ProviderMicrosoft,
    EventID:          "instance456",
    RecurringEventID: "series123",
    CalendarID:       "AAMkAGVmMDEz...",
    UpdateMode:       "this",
    Title:            "Standup - Special Topic Today",
    Start:            &instanceStart,
    End:              &instanceEnd,
})

// Update all future occurrences
updatedFuture, err := client.Events().Update(ctx, &mobiscroll.EventUpdateData{
    Provider:   mobiscroll.ProviderApple,
    EventID:    "recurring-event-id",
    CalendarID: "https://caldav.icloud.com/.../calendars/...",
    UpdateMode: "following",
    Location:   "New Conference Room B",
})

# Update a simple event
updated_event = client.events.update(
  provider:    Mobiscroll::Connect::Provider::GOOGLE,
  calendar_id: 'primary',
  event_id:    'event123abc',
  title:       'Updated Team Meeting',
  start:       '2025-11-01T14:00:00Z',
  end:         '2025-11-01T15:00:00Z'
)

# Update a single instance of a recurring event
updated_instance = client.events.update(
  provider:           Mobiscroll::Connect::Provider::MICROSOFT,
  event_id:           'instance456',
  recurring_event_id: 'series123',
  calendar_id:        'AAMkAGVmMDEz...',
  update_mode:        'this',
  title:              'Standup - Special Topic Today',
  start:              '2025-11-01T09:00:00Z',
  end:                '2025-11-01T10:00:00Z'
)

# Update all future occurrences
updated_future = client.events.update(
  provider:    Mobiscroll::Connect::Provider::APPLE,
  event_id:    'recurring-event-id',
  calendar_id: 'https://caldav.icloud.com/.../calendars/...',
  update_mode: 'following',
  location:    'New Conference Room B'
)

info

The provider parameter must match the calendar provider where the event exists
For recurring events, use recurringEventId and updateMode to control update scope
Only include fields you want to update; omitted fields remain unchanged
When using updateMode: 'this' on a recurring event, a new exception instance may be created
The updateMode parameter behavior may vary slightly between providers

Delete Event

Deletes a calendar event.

Supports deleting single events, recurring event series, or individual instances of recurring events. For recurring events, you can specify whether to delete only the current instance, all following instances, or the entire series.

Endpoint: DELETE /event

Request Body

providerstringRequired

Calendar provider where the event exists. One of: 'google', 'microsoft', 'apple', or 'caldav'.

eventIdstringRequired

The event identifier to delete.

calendarIdstringRequired

The calendar identifier containing the event.

recurringEventIdstring

The ID of the recurring event series. Required when deleting an instance of a recurring event.

Default: undefined

deleteModestring

Controls which events in a recurring series are deleted:

'this' - Delete only this specific instance
'following' - Delete this and all following instances
'all' - Delete all instances in the series

Only applicable for recurring events. If not specified, deletes the single event or entire series.

Default: undefined

Response

successboolean

Indicates whether the event was deleted successfully.

messagestring

Confirmation or error message.

Error Responses

400 - Bad Request. Invalid request data or missing required fields
401 - Unauthorized. Invalid or missing bearer token
404 - Not Found. Event or calendar not found
500 - Internal Server Error. Provider error or unexpected failure

Examples

Delete a simple event
DELETE /event
Content-Type: application/json

{
  "provider": "google",
  "eventId": "event123abc",
  "calendarId": "primary"
}

Response
{
  "success": true,
  "message": "Event deleted successfully"
}

Delete a single instance of a recurring event
DELETE /event
Content-Type: application/json

{
  "provider": "microsoft",
  "eventId": "instance456",
  "recurringEventId": "series123",
  "calendarId": "AAMkAGVmMDEz...",
  "deleteMode": "this"
}

Delete entire recurring series
DELETE /event
Content-Type: application/json

{
  "provider": "apple",
  "eventId": "recurring-event-id",
  "calendarId": "https://caldav.icloud.com/.../calendars/...",
  "deleteMode": "all"
}

// Delete a simple event
await client.events.delete({
  provider: 'google',
  calendarId: 'primary',
  eventId: 'event123abc'
});

// Delete a single instance of a recurring event
await client.events.delete({
  provider: 'microsoft',
  calendarId: 'AAMkAGVmMDEz...',
  eventId: 'instance456',
  recurringEventId: 'series123',
  deleteMode: 'this'
});

// Delete entire recurring series
await client.events.delete({
  provider: 'apple',
  calendarId: 'https://caldav.icloud.com/.../calendars/...',
  eventId: 'recurring-event-id',
  deleteMode: 'all'
});

# Delete a simple event
client.events.delete({
    'provider': 'google',
    'calendarId': 'primary',
    'eventId': 'event123abc',
})

# Delete a single instance of a recurring event
client.events.delete({
    'provider': 'microsoft',
    'calendarId': 'AAMkAGVmMDEz...',
    'eventId': 'instance456',
    'recurringEventId': 'series123',
    'deleteMode': 'this',
})

# Delete entire recurring series
client.events.delete({
    'provider': 'apple',
    'calendarId': 'https://caldav.icloud.com/.../calendars/...',
    'eventId': 'recurring-event-id',
    'deleteMode': 'all',
})

// Delete a simple event
$client->events()->delete([
    'provider' => 'google',
    'calendarId' => 'primary',
    'eventId' => 'event123abc',
]);

// Delete a single instance of a recurring event
$client->events()->delete([
    'provider' => 'microsoft',
    'calendarId' => 'AAMkAGVmMDEz...',
    'eventId' => 'instance456',
    'recurringEventId' => 'series123',
    'deleteMode' => 'this',
]);

// Delete entire recurring series
$client->events()->delete([
    'provider' => 'apple',
    'calendarId' => 'https://caldav.icloud.com/.../calendars/...',
    'eventId' => 'recurring-event-id',
    'deleteMode' => 'all',
]);

// Delete a simple event
await client.Events.DeleteAsync(new DeleteEventParams
{
    Provider = "google",
    CalendarId = "primary",
    EventId = "event123abc",
});

// Delete a single instance of a recurring event
await client.Events.DeleteAsync(new DeleteEventParams
{
    Provider = "microsoft",
    CalendarId = "AAMkAGVmMDEz...",
    EventId = "instance456",
    RecurringEventId = "series123",
    DeleteMode = "this",
});

// Delete entire recurring series
await client.Events.DeleteAsync(new DeleteEventParams
{
    Provider = "apple",
    CalendarId = "https://caldav.icloud.com/.../calendars/...",
    EventId = "recurring-event-id",
    DeleteMode = "all",
});

import com.mobiscroll.connect.Provider;
import com.mobiscroll.connect.models.EventDeleteParams;

// Delete a simple event
client.events().delete(EventDeleteParams.builder()
    .provider(Provider.GOOGLE)
    .calendarId("primary")
    .eventId("event123abc")
    .build());

// Delete a single instance of a recurring event
client.events().delete(EventDeleteParams.builder()
    .provider(Provider.MICROSOFT)
    .calendarId("AAMkAGVmMDEz...")
    .eventId("instance456")
    .recurringEventId("series123")
    .deleteMode("this")
    .build());

// Delete entire recurring series
client.events().delete(EventDeleteParams.builder()
    .provider(Provider.APPLE)
    .calendarId("https://caldav.icloud.com/.../calendars/...")
    .eventId("recurring-event-id")
    .deleteMode("all")
    .build());

// Delete a simple event
err := client.Events().Delete(ctx, &mobiscroll.EventDeleteParams{
    Provider:   mobiscroll.ProviderGoogle,
    CalendarID: "primary",
    EventID:    "event123abc",
})

// Delete a single instance of a recurring event
err = client.Events().Delete(ctx, &mobiscroll.EventDeleteParams{
    Provider:         mobiscroll.ProviderMicrosoft,
    CalendarID:       "AAMkAGVmMDEz...",
    EventID:          "instance456",
    RecurringEventID: "series123",
    DeleteMode:       "this",
})

// Delete entire recurring series
err = client.Events().Delete(ctx, &mobiscroll.EventDeleteParams{
    Provider:   mobiscroll.ProviderApple,
    CalendarID: "https://caldav.icloud.com/.../calendars/...",
    EventID:    "recurring-event-id",
    DeleteMode: "all",
})

# Delete a simple event
client.events.delete(
  provider:    Mobiscroll::Connect::Provider::GOOGLE,
  calendar_id: 'primary',
  event_id:    'event123abc'
)

# Delete a single instance of a recurring event
client.events.delete(
  provider:           Mobiscroll::Connect::Provider::MICROSOFT,
  calendar_id:        'AAMkAGVmMDEz...',
  event_id:           'instance456',
  recurring_event_id: 'series123',
  delete_mode:        'this'
)

# Delete entire recurring series
client.events.delete(
  provider:    Mobiscroll::Connect::Provider::APPLE,
  calendar_id: 'https://caldav.icloud.com/.../calendars/...',
  event_id:    'recurring-event-id',
  delete_mode: 'all'
)

info

The provider parameter must match the calendar provider where the event exists
For recurring events, use recurringEventId and deleteMode to control deletion scope
Deleting with deleteMode: 'this' creates an exception (cancelled instance) in the series
Deleting with deleteMode: 'all' removes the entire recurring series
Deleted events cannot be recovered through the API
The deleteMode parameter behavior may vary slightly between providers

List Events​

Request Parameters​

Response​

Error Responses​

Examples​

Create Event​

Request Body​

Response​

Error Responses​

Examples​

Update Event​

Request Body​

Response​

Error Responses​

Examples​

Delete Event​

Request Body​

Response​

Error Responses​

Examples​

List Events

Request Parameters

Response

Error Responses

Examples

Create Event

Request Body

Response

Error Responses

Examples

Update Event

Request Body

Response

Error Responses

Examples

Delete Event

Request Body

Response

Error Responses

Examples