Skip to main content

Calendar

The Calendar API provides endpoints for retrieving calendar information from the system. These endpoints allow you to fetch details about specific calendars and list calendars with various filtering options.

🔒 Authentication​

All Calendar API endpoints require authentication using the ONLIVESITE authentication scheme. Include the following header in all requests:

Authorization: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature

📌 Available Endpoints​

Calendar Operations (v2)​

  • Get Calendar — GET /api/v2/calendars/{id}
  • List Calendars — GET /api/v2/calendars

💡 Common Use Cases​

  • View agent calendar availability
  • Search for available resources
  • Calendar information retrieval
  • Resource capacity checking
  • Team calendar discovery
  • Asset calendar lookup

🔐 Access Control​

  • Read access is organization-scoped
  • Type-based visibility (agent vs. asset calendars)
  • Group-based access restrictions
  • Calendar-specific view permissions

🌐 Integration Features​

  • Timezone-aware calendar data
  • Flexible calendar filtering
  • Tag-based calendar search
  • Pagination support for large datasets
  • Custom field querying

For detailed information about the available operations, please refer to the individual endpoint documentation sections.

🔗 Related Sections​

  • Availabilities: manage working hours, overrides, and unavailable ranges — see Availabilities/