For the complete documentation index, see llms.txt. This page is also available as Markdown.

API - Calendars and Meetings

This guide explains how to obtain information from calendars and their respective schedules. The process is divided into two main stages: listing available calendars and querying meetings by period.

1. Calendar Listing

The first step is to retrieve the list of calendars associated with the user or system. This endpoint uses a query structure to filter the desired fields.

  • Endpoint: GET /pcalendar

  • Query Parameters: query: Defines the return fields (e.g., id, name, isPublished, etc).

Request Example

GET /pcalendar?query={calendars{id,name,isPublished,createDate,userId,updateDate,publicId,userId,nextMeeting}}

Tip:

Keep the id (or publicId) of the calendar returned in this call, as it will be required for the next step.


2. Meeting Query by Calendar

After identifying the calendar ID, you can list all scheduled meetings within a specific time interval.

  • Endpoint: GET /calendarmeeting/{calendarId}

  • URL and Query Parameters:

    • calendarId (Path): The numeric identifier of the calendar (e.g., 71).

    • page: Page index for pagination (starts at 0).

    • from: Start date in ISO 8601 format.

Request Example

GET /calendarmeeting/71?page=0&from=2026-04-01T03:00:00.000Z


Flow Summary

  1. Initial Call: Execute the GET on /pcalendar to obtain the calendar mapping.

  2. Selection: The user or system chooses an id from the returned list.

  3. Retrieval: Execute the GET on /calendarmeeting/{id} passing the time and page parameters to display the meetings.


Technical Notes

  • Date Format: Make sure to send dates in UTC (Z) standard to avoid time zone conflicts.

  • Pagination: The parameter page is essential for calendars with a high volume of meetings.

Last updated

Was this helpful?