List Events

Required permissions: events.read.*

GET /calendars/{calendar_id}/events

List Events

cURL

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>'

import requests

url = "https://{primary_domain}/api/public/v2.0/calendars/{calendar_id}/events"

headers = {
    "X-Access-Key-Id": "<api-key>",
    "X-Access-Key-Secret": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Access-Key-Id': '<api-key>', 'X-Access-Key-Secret': '<api-key>'}
};

fetch('https://{primary_domain}/api/public/v2.0/calendars/{calendar_id}/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{primary_domain}/api/public/v2.0/calendars/{calendar_id}/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Access-Key-Id: <api-key>",
    "X-Access-Key-Secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{primary_domain}/api/public/v2.0/calendars/{calendar_id}/events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Access-Key-Id", "<api-key>")
	req.Header.Add("X-Access-Key-Secret", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("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>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{primary_domain}/api/public/v2.0/calendars/{calendar_id}/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Access-Key-Id"] = '<api-key>'
request["X-Access-Key-Secret"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "message": "<string>",
  "data": [
    {
      "id": 123,
      "calendar_id": 123,
      "title": "<string>",
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z",
      "attendees": [
        {
          "email": "[e-mail]",
          "name": "<string>",
          "is_organizer": true,
          "customer_id": 123,
          "calendar_id": 123
        }
      ],
      "body": "<string>",
      "location": "<string>",
      "cancel_note": "<string>",
      "canceled_by_id": 123,
      "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"
      }
    }
  ]
}

{
  "message": "<string>",
  "errors": {
    "attribute": [
      "The {attribute} field is required."
    ]
  }
}

"Invalid or missing access key."

"Too many requests."

"An unexpected error occurred."

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

200

application/json

message · string · required

data · object[] · required

A list of Event resource objects.

Show child attributes