List Scheduled Events - Zeeg Developer Hub

GET

scheduled-events

List scheduled events

curl --request GET \
  --url https://api.zeeg.me/v2/scheduled-events \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.zeeg.me/v2/scheduled-events"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.zeeg.me/v2/scheduled-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://api.zeeg.me/v2/scheduled-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 => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.zeeg.me/v2/scheduled-events"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.zeeg.me/v2/scheduled-events")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.zeeg.me/v2/scheduled-events")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "collection": [
    {
      "uri": "https://api.zeeg.me/v2/scheduled-events/zg-O69bac566950c6",
      "uuid": "zg-O69bac566950c6",
      "title": "30-Minute Discovery Call",
      "type": "ONE_ON_ONE",
      "startTime": "2026-04-15T09:00:00.000000Z",
      "endTime": "2026-04-15T09:30:00.000000Z",
      "duration": 30,
      "status": "confirmed",
      "eventTypeUri": "https://api.zeeg.me/v2/event-types/80f46bf5-eb01-4c07-960e-a9a3e18aae5e",
      "location": {
        "type": "Google Meet",
        "joinUrl": "https://meet.google.com/abc-defg-hij"
      },
      "maxActiveInvitees": 1,
      "activeInviteesCount": 1,
      "invitees": [
        {
          "uuid": "zg-O69bad4047abf0",
          "salutation": "Ms.",
          "fullName": "Sophie Laurent",
          "email": "sophie.laurent@northwind.io",
          "guests": [
            "alex.chen@northwind.io"
          ],
          "timeZone": "Europe/Paris",
          "cancellation": {
            "cancelledAt": null,
            "cancelledBy": null,
            "cancellerType": null,
            "cancellationReason": null
          },
          "payment": null,
          "questions": [
            {
              "answer": "Product demo and pricing options",
              "answer_type": "STRING",
              "question": "What would you like to discuss?"
            }
          ],
          "scheduledAt": "2026-04-10T08:30:00.000000Z",
          "utm": {
            "utm_campaign": "spring_launch",
            "utm_source": "linkedin",
            "utm_medium": "social",
            "utm_content": null,
            "utm_term": null
          }
        }
      ],
      "guests": [
        "alex.chen@northwind.io"
      ],
      "hosts": [
        {
          "firstName": "Lena",
          "lastName": "Meier",
          "email": "lena.meier@horizondigital.de",
          "slug": "lena-meier",
          "url": "https://zeeg.me/lena-meier",
          "avatarUrl": null
        }
      ],
      "createdAt": "2026-04-10T08:30:00.000000Z",
      "updatedAt": "2026-04-10T08:30:02.000000Z",
      "currentTime": "2026-03-23T10:00:00.000000Z"
    },
    {
      "uri": "https://api.zeeg.me/v2/scheduled-events/zg-O69bad4047abf0",
      "uuid": "zg-O69bad4047abf0",
      "title": "30-Minute Discovery Call",
      "type": "ONE_ON_ONE",
      "startTime": "2026-04-18T14:00:00.000000Z",
      "endTime": "2026-04-18T14:30:00.000000Z",
      "duration": 30,
      "status": "cancelled",
      "eventTypeUri": "https://api.zeeg.me/v2/event-types/80f46bf5-eb01-4c07-960e-a9a3e18aae5e",
      "location": {
        "type": "Google Meet",
        "joinUrl": "https://meet.google.com/klm-nopq-rst"
      },
      "maxActiveInvitees": 1,
      "activeInviteesCount": 0,
      "invitees": [
        {
          "uuid": "zg-O69bac566950c6",
          "salutation": null,
          "fullName": "Marco Rossi",
          "email": "marco.rossi@horizondigital.de",
          "guests": null,
          "timeZone": "Europe/Berlin",
          "cancellation": {
            "cancelledAt": "2026-04-17T10:00:00.000000Z",
            "cancelledBy": "marco.rossi@horizondigital.de",
            "cancellerType": "host",
            "cancellationReason": "Schedule conflict with another commitment."
          },
          "payment": null,
          "questions": null,
          "scheduledAt": "2026-04-12T11:00:00.000000Z",
          "utm": {
            "utm_campaign": null,
            "utm_source": null,
            "utm_medium": null,
            "utm_content": null,
            "utm_term": null
          }
        }
      ],
      "guests": null,
      "hosts": [
        {
          "firstName": "Lena",
          "lastName": "Meier",
          "email": "lena.meier@horizondigital.de",
          "slug": "lena-meier",
          "url": "https://zeeg.me/lena-meier",
          "avatarUrl": null
        }
      ],
      "createdAt": "2026-04-12T11:00:00.000000Z",
      "updatedAt": "2026-04-17T10:00:00.000000Z",
      "currentTime": "2026-03-23T10:00:00.000000Z"
    }
  ],
  "pagination": {
    "total": 2,
    "count": 2,
    "totalPages": 1,
    "previousPage": null,
    "currentPage": 1,
    "nextPage": null
  }
}

{
  "message": "Unauthenticated."
}

{
  "error": {
    "type": "insufficient_scope",
    "message": "Your token is missing the required scope(s). Include at least one of: events:read, events:write.",
    "error_id": "9cfa47d0-d633-44ba-b3a8-0845d4fca38a",
    "required_scopes": [
      "events:read",
      "events:write"
    ]
  }
}

{
  "message": "The selected status is invalid.",
  "errors": {
    "status": [
      "The selected status is invalid."
    ]
  }
}

Authorizations

Authorization

string

header

required

Query Parameters

sort

enum<string>

default:asc

Order results based on the startTime.

Available options:

asc,

desc

count

number

default:20

Limit the number of returned results per page.

Required range: 1 <= x <= 100

status

enum<string>

Filter based on event status. Possible values are: active, cancelled. Omit for all events.

Available options:

confirmed,

cancelled

minStartTime

string<date-time>

Filter for events starting after the specified time.

Example:

"2026-04-01T00:00:00.000000Z"

maxStartTime

string<date-time>

Filter for events starting before the specified time.

Example:

"2026-04-30T23:59:59.000000Z"

scope

enum<string>

Filters results based on the scope. Currently only 'all' is supported, returning all events of the whole organization. More options coming soon.

Available options:

all

userSlug

string

Filter for events hosted by a specific user in your organization based on the user's slug.

Example:

"lena-meier"

hostEmail

string<email>

Filter for events hosted by a specific user in your organization based on the user's email address.

Example:

"lena.meier@horizondigital.de"

inviteeEmail

string<email>

Filter for events of a specific invitee by their email address.

Example:

"sophie.laurent@northwind.io"

teamSlug

string

Filter for events that belong to a specific team in your organization based on the team's slug.

keyword

string

Search through events with a keyword.

page

number

Page number for paginated results.

Required range: x >= 1

Response

pagination

object

required

Hide child attributes

pagination.total

integer

required

Total number of records.

Required range: x >= 0

pagination.count

integer

default:20

required

Number of records per page.

Required range: x >= 0

pagination.totalPages

integer

required

Total number of pages.

Required range: x >= 0

pagination.currentPage

integer

required

Current page number.

Required range: x >= 1

pagination.previousPage

string | null

Link to previous page, or null.

Example:

"/v2/scheduled-events?page=1"

pagination.nextPage

string | null

Link to next page, or null.

Example:

"/v2/scheduled-events?page=3"

collection

object[]

Hide child attributes

collection.uri

string<uri>

required

Public API URI of the scheduled event resource.

collection.uuid

string

required

Zeeg event identifier (zg-XXX format)

Example:

"zg-O69bac566950c6"

collection.title

string

required

Title of the scheduled event.

collection.type

string

required

Event type kind (e.g. ONE_ON_ONE, GROUP, ROUND_ROBIN).

collection.startTime

string<date-time>

required

ISO 8601 UTC start time of the booked event.

collection.endTime

string<date-time>

required

ISO 8601 UTC end time of the booked event.

collection.duration

integer

required

Event duration in minutes.

collection.status

string

required

Booking status (e.g. confirmed, cancelled).

collection.eventTypeUri

string<uri>

required

Public API URI of the event type this booking was made against.

collection.maxActiveInvitees

integer

required

Maximum number of active invitees the event allows.

collection.activeInviteesCount

integer

required

Current number of active (non-cancelled) invitees.

collection.invitees

object[]

required

Invitees booked on the scheduled event.

Hide child attributes

collection.invitees.fullName

string | null

required

Full name of the invitee.

collection.invitees.email

string<email> | null

required

Email address of the invitee.

collection.invitees.timeZone

string | null

required

IANA time zone of the invitee.

collection.invitees.scheduledAt

string<date-time> | null

required

ISO 8601 UTC timestamp when the invitee booked.

collection.invitees.uuid

string

Zeeg attendee identifier (zg-XXX format)

Example:

"zg-O69bac566950c6"

collection.invitees.salutation

string | null

Salutation for the invitee, if collected.

collection.invitees.guests

string[] | null

Array of additional emails invited

collection.invitees.cancellation

object

Cancellation details. All fields are null when the invitee is not cancelled.

Hide child attributes

collection.invitees.cancellation.cancelledAt

string<date-time> | null

ISO 8601 UTC timestamp when the invitee was cancelled.

collection.invitees.cancellation.cancelledBy

string | null

Identifier of who cancelled the booking.

collection.invitees.cancellation.cancellerType

string | null

Type of canceller (e.g. host, invitee).

collection.invitees.cancellation.cancellationReason

string | null

Reason given for the cancellation.

collection.invitees.payment

object | null

Payment details for the booking, or null when no payment applies.

Hide child attributes

collection.invitees.payment.gateway

string

Payment provider, e.g. stripe or paypal.

collection.invitees.payment.price

number

collection.invitees.payment.currency

string

collection.invitees.payment.transactionId

string | null

collection.invitees.payment.createdAt

string<date-time>

collection.invitees.payment.status

enum<string>

pending until the transaction completes.

Available options:

pending,

success

collection.invitees.utm

object

UTM tracking parameters captured at booking time.

Hide child attributes

collection.invitees.utm.utm_campaign

string | null

collection.invitees.utm.utm_source

string | null

collection.invitees.utm.utm_medium

string | null

collection.invitees.utm.utm_content

string | null

collection.invitees.utm.utm_term

string | null

collection.invitees.customQueryParams

any[]

Custom query parameters captured at booking time.

collection.invitees.questions

object[] | null

Booking questions answered by the invitee.

Hide child attributes

collection.invitees.questions.answer

string

collection.invitees.questions.answer_type

string

collection.invitees.questions.question

string

collection.invitees.agentBookingReference

string | null

Reference code for bookings made via the AI agent; null otherwise.

collection.createdAt

string<date-time>

required

ISO 8601 UTC timestamp when the booking was created.

collection.location

object | null

Meeting location for the booking.

Hide child attributes

collection.location.type

string

required

Location type (e.g. google_meet, zoom, phone, in_person).

collection.location.joinUrl

string<uri> | null

Join URL for the meeting, when applicable.

collection.guests

string[] | null

Array of additional emails invited

collection.hosts

object[] | null

Hosts assigned to the scheduled event.

Hide child attributes

collection.hosts.firstName

string | null

required

Host's first name.

collection.hosts.email

string<email> | null

required

Host's email address.

collection.hosts.slug

string | null

required

Host's public profile slug.

collection.hosts.url

string<uri>

required

Host's public profile URL.

collection.hosts.lastName

string

Host's last name. Empty string when not set.

collection.hosts.avatarUrl

string<uri> | null

URL of the host's avatar image, if set.

collection.updatedAt

string<date-time>

ISO 8601 UTC timestamp when the booking was last updated.

collection.currentTime

string<date-time>

Current server time

Last modified on April 29, 2026

Get a Scheduled Event

List scheduled events

curl --request GET \
  --url https://api.zeeg.me/v2/scheduled-events \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.zeeg.me/v2/scheduled-events"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.zeeg.me/v2/scheduled-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://api.zeeg.me/v2/scheduled-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 => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.zeeg.me/v2/scheduled-events"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.zeeg.me/v2/scheduled-events")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.zeeg.me/v2/scheduled-events")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "collection": [
    {
      "uri": "https://api.zeeg.me/v2/scheduled-events/zg-O69bac566950c6",
      "uuid": "zg-O69bac566950c6",
      "title": "30-Minute Discovery Call",
      "type": "ONE_ON_ONE",
      "startTime": "2026-04-15T09:00:00.000000Z",
      "endTime": "2026-04-15T09:30:00.000000Z",
      "duration": 30,
      "status": "confirmed",
      "eventTypeUri": "https://api.zeeg.me/v2/event-types/80f46bf5-eb01-4c07-960e-a9a3e18aae5e",
      "location": {
        "type": "Google Meet",
        "joinUrl": "https://meet.google.com/abc-defg-hij"
      },
      "maxActiveInvitees": 1,
      "activeInviteesCount": 1,
      "invitees": [
        {
          "uuid": "zg-O69bad4047abf0",
          "salutation": "Ms.",
          "fullName": "Sophie Laurent",
          "email": "sophie.laurent@northwind.io",
          "guests": [
            "alex.chen@northwind.io"
          ],
          "timeZone": "Europe/Paris",
          "cancellation": {
            "cancelledAt": null,
            "cancelledBy": null,
            "cancellerType": null,
            "cancellationReason": null
          },
          "payment": null,
          "questions": [
            {
              "answer": "Product demo and pricing options",
              "answer_type": "STRING",
              "question": "What would you like to discuss?"
            }
          ],
          "scheduledAt": "2026-04-10T08:30:00.000000Z",
          "utm": {
            "utm_campaign": "spring_launch",
            "utm_source": "linkedin",
            "utm_medium": "social",
            "utm_content": null,
            "utm_term": null
          }
        }
      ],
      "guests": [
        "alex.chen@northwind.io"
      ],
      "hosts": [
        {
          "firstName": "Lena",
          "lastName": "Meier",
          "email": "lena.meier@horizondigital.de",
          "slug": "lena-meier",
          "url": "https://zeeg.me/lena-meier",
          "avatarUrl": null
        }
      ],
      "createdAt": "2026-04-10T08:30:00.000000Z",
      "updatedAt": "2026-04-10T08:30:02.000000Z",
      "currentTime": "2026-03-23T10:00:00.000000Z"
    },
    {
      "uri": "https://api.zeeg.me/v2/scheduled-events/zg-O69bad4047abf0",
      "uuid": "zg-O69bad4047abf0",
      "title": "30-Minute Discovery Call",
      "type": "ONE_ON_ONE",
      "startTime": "2026-04-18T14:00:00.000000Z",
      "endTime": "2026-04-18T14:30:00.000000Z",
      "duration": 30,
      "status": "cancelled",
      "eventTypeUri": "https://api.zeeg.me/v2/event-types/80f46bf5-eb01-4c07-960e-a9a3e18aae5e",
      "location": {
        "type": "Google Meet",
        "joinUrl": "https://meet.google.com/klm-nopq-rst"
      },
      "maxActiveInvitees": 1,
      "activeInviteesCount": 0,
      "invitees": [
        {
          "uuid": "zg-O69bac566950c6",
          "salutation": null,
          "fullName": "Marco Rossi",
          "email": "marco.rossi@horizondigital.de",
          "guests": null,
          "timeZone": "Europe/Berlin",
          "cancellation": {
            "cancelledAt": "2026-04-17T10:00:00.000000Z",
            "cancelledBy": "marco.rossi@horizondigital.de",
            "cancellerType": "host",
            "cancellationReason": "Schedule conflict with another commitment."
          },
          "payment": null,
          "questions": null,
          "scheduledAt": "2026-04-12T11:00:00.000000Z",
          "utm": {
            "utm_campaign": null,
            "utm_source": null,
            "utm_medium": null,
            "utm_content": null,
            "utm_term": null
          }
        }
      ],
      "guests": null,
      "hosts": [
        {
          "firstName": "Lena",
          "lastName": "Meier",
          "email": "lena.meier@horizondigital.de",
          "slug": "lena-meier",
          "url": "https://zeeg.me/lena-meier",
          "avatarUrl": null
        }
      ],
      "createdAt": "2026-04-12T11:00:00.000000Z",
      "updatedAt": "2026-04-17T10:00:00.000000Z",
      "currentTime": "2026-03-23T10:00:00.000000Z"
    }
  ],
  "pagination": {
    "total": 2,
    "count": 2,
    "totalPages": 1,
    "previousPage": null,
    "currentPage": 1,
    "nextPage": null
  }
}

{
  "message": "Unauthenticated."
}

{
  "error": {
    "type": "insufficient_scope",
    "message": "Your token is missing the required scope(s). Include at least one of: events:read, events:write.",
    "error_id": "9cfa47d0-d633-44ba-b3a8-0845d4fca38a",
    "required_scopes": [
      "events:read",
      "events:write"
    ]
  }
}

{
  "message": "The selected status is invalid.",
  "errors": {
    "status": [
      "The selected status is invalid."
    ]
  }
}