Get calendar event — Brigg developers

Access & visibility

Allow meetings.GetCalendarEvent on your API key. Resource read permissions: core:CalendarEvent.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

idstringRequired

ID of a visible core:CalendarEvent record. Find it with meetings.ListCalendarEvents. Use the record's top-level id, not a business field or account ID.

Response

Returns 200 OK with a JSON body.

item: null means there is no matching record visible to this caller. It does not reveal whether an inaccessible record exists.

Record metadata sits outside data. Timestamps created_at and updated_at are Unix milliseconds. Optional business fields may be absent; absence does not mean false or zero. A field accepts null only when its type includes null.

A scheduled calendar event and a recorded meeting have separate IDs and lifecycles. Calendar event operations distinguish Brigg-owned invitations from connected Google or Microsoft events.

This list reads stored calendar records visible to the caller, including synchronized connected-calendar events. It does not call Google or Microsoft live, and it is not a free/busy guarantee. A workspace-only key cannot read a member's private synchronized calendar; use approved delegation to that member. Provider synchronization and calendar selection determine which external events have reached Brigg.

itemCalendarEventRecordRequired

null when no such record

CalendarEventRecord

idstringRequired

Stable core:CalendarEvent record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited.

created_atnumberRequired

Time the record was created, in Unix milliseconds.

updated_atnumberRequired

Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads.

created_bystring or nullRequired

Account that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID.

privatebooleanRequired

True for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules.

dataCalendarEventRequired

The record's fields.

CalendarEvent

Schedule5 fields

titlestringRequired

Title shown in the calendar invitation.

startstringRequired

Scheduled start as an ISO 8601 UTC timestamp, for example 2026-10-06T09:00:00.000Z.

endstringRequired

Scheduled end as an ISO 8601 UTC timestamp; later than start.

locationstringOptional

Location or meeting link shown in the invitation.

descriptionstringOptional

Description included with the scheduled event.

Meeting content3 fields

agendastringOptional

Planned discussion topics as text.

notesstringOptional

Notes recorded on the calendar event; personal meeting notes are a separate resource.

attendeesarray of CalendarAttendeeOptional

Invitation recipients and their responses. Each attendee is identified by email.

Item fields

emailstringRequired

Email address.

namestringOptional

Display name.

selfbooleanOptional

Whether this attendee represents the connected calendar's owner.

Allowed: false, true.

response_statusstringOptional

Attendee's invitation response: needs_action, accepted, declined or tentative.

Allowed: "needs_action", "accepted", "declined", "tentative".

optionalbooleanOptional

Whether attendance is optional.

Allowed: false, true.

resourcebooleanOptional

Whether the attendee represents a bookable resource such as a room.

Allowed: false, true.

Calendar identity2 fields

uidstringOptional

Calendar invitation UID used to correlate updates and cancellations; distinct from the Brigg record ID.

sequencenumberOptional

Calendar invitation revision number used to order invitation updates.

Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status	Code	What to do
400	`invalid_json`	Send a JSON object with Content-Type: application/json.
400	`invalid_input`	Check the request fields and types.
401	`invalid_key`	The workspace API key is missing, invalid or revoked.
403	`forbidden`	Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of a visible `core:CalendarEvent` record. Find it with [meetings.ListCalendarEvents](/developers/reference/meetings/ListCalendarEvents). Use the record's top-level `id`, not a business field or account ID."
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "id": "e_calendarevent_example"
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "item": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Stable core:CalendarEvent record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited."
        },
        "created_at": {
          "type": "number",
          "description": "Time the record was created, in Unix milliseconds."
        },
        "updated_at": {
          "type": "number",
          "description": "Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads."
        },
        "created_by": {
          "type": [
            "string",
            "null"
          ],
          "description": "Account that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID."
        },
        "private": {
          "type": "boolean",
          "description": "True for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules."
        },
        "data": {
          "type": "object",
          "properties": {
            "title": {
              "type": "string",
              "description": "Title shown in the calendar invitation."
            },
            "start": {
              "type": "string",
              "description": "Scheduled start as an ISO 8601 UTC timestamp, for example 2026-10-06T09:00:00.000Z."
            },
            "end": {
              "type": "string",
              "description": "Scheduled end as an ISO 8601 UTC timestamp; later than start."
            },
            "location": {
              "type": "string",
              "description": "Location or meeting link shown in the invitation."
            },
            "description": {
              "type": "string",
              "description": "Description included with the scheduled event."
            },
            "agenda": {
              "type": "string",
              "description": "Planned discussion topics as text."
            },
            "notes": {
              "type": "string",
              "description": "Notes recorded on the calendar event; personal meeting notes are a separate resource."
            },
            "attendees": {
              "type": "array",
              "items": {
                "title": "CalendarAttendee",
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "description": "Email address."
                  },
                  "name": {
                    "type": "string",
                    "description": "Display name."
                  },
                  "self": {
                    "type": "boolean",
                    "enum": [
                      false,
                      true
                    ],
                    "description": "Whether this attendee represents the connected calendar's owner."
                  },
                  "response_status": {
                    "type": "string",
                    "enum": [
                      "needs_action",
                      "accepted",
                      "declined",
                      "tentative"
                    ],
                    "description": "Attendee's invitation response: needs_action, accepted, declined or tentative."
                  },
                  "optional": {
                    "type": "boolean",
                    "enum": [
                      false,
                      true
                    ],
                    "description": "Whether attendance is optional."
                  },
                  "resource": {
                    "type": "boolean",
                    "enum": [
                      false,
                      true
                    ],
                    "description": "Whether the attendee represents a bookable resource such as a room."
                  }
                },
                "required": [
                  "email"
                ],
                "additionalProperties": false
              },
              "description": "Invitation recipients and their responses. Each attendee is identified by email."
            },
            "uid": {
              "type": "string",
              "description": "Calendar invitation UID used to correlate updates and cancellations; distinct from the Brigg record ID."
            },
            "sequence": {
              "type": "number",
              "description": "Calendar invitation revision number used to order invitation updates."
            }
          },
          "required": [
            "title",
            "start",
            "end"
          ],
          "additionalProperties": false,
          "description": "The record's fields.",
          "title": "CalendarEvent"
        }
      },
      "required": [
        "id",
        "created_at",
        "updated_at",
        "created_by",
        "private",
        "data"
      ],
      "additionalProperties": false,
      "description": "null when no such record",
      "title": "CalendarEventRecord"
    }
  },
  "required": [
    "item"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "item": {
        "id": "e_calendarevent_example",
        "created_at": 1791276900000,
        "updated_at": 1791280800000,
        "created_by": "a_jamie",
        "private": false,
        "data": {
          "title": "Northstar project kickoff",
          "start": "2026-10-06T09:00:00.000Z",
          "end": "2026-10-06T09:45:00.000Z",
          "attendees": [
            {
              "email": "alex@example.org",
              "name": "Alex Morgan",
              "response_status": "accepted"
            }
          ],
          "uid": "kickoff@example.com",
          "sequence": 0
        }
      }
    }
  ]
}

Try the request

Use your API key in a server environment.

Example scenarioAct as a memberRequires administrator-approved delegation.

Fictional values. Replace IDs and business details with values from your workspace.

Request

cURL

curl 'https://api.brigg.app/v1/operations/meetings.GetCalendarEvent' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": "e_calendarevent_example"
}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/meetings.GetCalendarEvent", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "e_calendarevent_example"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "id": "e_calendarevent_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/meetings.GetCalendarEvent",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/meetings.GetCalendarEvent' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{
  "id": "e_calendarevent_example"
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const response = await fetch("https://api.brigg.app/v1/operations/meetings.GetCalendarEvent", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({
    "id": "e_calendarevent_example"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "id": "e_calendarevent_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/meetings.GetCalendarEvent",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "item": {
    "id": "e_calendarevent_example",
    "created_at": 1791276900000,
    "updated_at": 1791280800000,
    "created_by": "a_jamie",
    "private": false,
    "data": {
      "title": "Northstar project kickoff",
      "start": "2026-10-06T09:00:00.000Z",
      "end": "2026-10-06T09:45:00.000Z",
      "attendees": [
        {
          "email": "alex@example.org",
          "name": "Alex Morgan",
          "response_status": "accepted"
        }
      ],
      "uid": "kickoff@example.com",
      "sequence": 0
    }
  }
}

Illustrative values, not a live response.

A missing or inaccessible record returns item: null. Do not treat this as proof that a record exists for another member.

Request

cURL

curl 'https://api.brigg.app/v1/operations/meetings.GetCalendarEvent' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": "e_calendarevent_example"
}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/meetings.GetCalendarEvent", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "e_calendarevent_example"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "id": "e_calendarevent_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/meetings.GetCalendarEvent",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/meetings.GetCalendarEvent' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{
  "id": "e_calendarevent_example"
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const response = await fetch("https://api.brigg.app/v1/operations/meetings.GetCalendarEvent", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({
    "id": "e_calendarevent_example"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "id": "e_calendarevent_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/meetings.GetCalendarEvent",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "item": null
}

Illustrative values, not a live response.