Skip to main content
GET
/
calendars
/
{calendar_id}
/
events
List Events
curl --request GET \
  --url https://{primary_domain}/api/public/v2.0/calendars/{calendar_id}/events \
  --header 'X-Access-Key-Id: <api-key>' \
  --header 'X-Access-Key-Secret: <api-key>'
{
  "message": "<string>",
  "data": [
    {
      "id": 123,
      "calendar_id": 123,
      "title": "<string>",
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z",
      "attendees": [
        {
          "email": "jsmith@example.com",
          "name": "<string>",
          "status": 0,
          "is_organizer": true,
          "customer_id": 123,
          "calendar_id": 123
        }
      ],
      "body": "<string>",
      "location": "<string>",
      "cancel_note": "<string>",
      "canceled_by_id": 123,
      "canceled_by_type": "App\\Models\\Tenant\\User",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "public_id": "<string>",
      "provider_event_id": "<string>",
      "customer_id": 123,
      "meeting_link_id": 123,
      "online_conference": {
        "id": 123,
        "online_conference_account_id": 123,
        "public_id": "<string>",
        "title": "<string>",
        "is_public": true,
        "deleted_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "backer_event_id": 123,
        "is_occurred": true,
        "started_at": "2023-11-07T05:31:56Z",
        "ended_at": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

Authorizations

​
X-Access-Key-Id
string
header
required
​
X-Access-Key-Secret
string
header
required

Path Parameters

​
calendar_id
integer
required

Query Parameters

​
from
string<date-time>
required
​
to
string<date-time>
required
​
with_trashed
boolean

Whether or not deleted items are included.

​
value
string

Value of attribute to filter query by.

​
operator
enum<string>

Comparison operator to filter query by.

Available options:
Equal,
NotEqual,
Contains,
GreaterThan,
GreaterThanOrEqual,
LessThan,
LessThanOrEqual,
IsNull,
NotNull
​
on
enum<string>

Attribute to filter query by

Available options:
id,
title,
attendees,
created_at,
deleted_at

Response

​
message
string
required
​
data
object[]
required

A list of Event resource objects.