Zum Hauptinhalt springen
GET
{baseUrl}
/
api
/
calendar
/
events
/
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "calendar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "Quarterly planning",
      "starts_at": "2023-11-07T05:31:56Z",
      "ends_at": "2023-11-07T05:31:56Z",
      "is_all_day": true,
      "location": "<string>",
      "conference_url": "<string>",
      "attendees": [
        {
          "email": "jsmith@example.com",
          "name": "<string>"
        }
      ]
    }
  ],
  "total": 12,
  "page": 1,
  "per_page": 20
}
Gibt Kalenderereignisse zuruck, die der authentifizierte Key lesen darf. Nutze diesen Endpunkt fur Sync-Jobs, Dashboards und Reporting-Tools.
Erforderlicher API-Key-Scope: calendar:read.

Query-Parameter

range_start
string
ISO-8601-Datetime fur den Beginn des Zeitfensters. Ohne Wert nutzt Pharen einen begrenzten Standardbereich.
range_end
string
ISO-8601-Datetime fur das Ende des Zeitfensters. Muss nach range_start liegen.
team_id
string
Team-UUID fur teambegrenzte Keys. Workspaceweite Keys konnen den Parameter weglassen.

Antwort

id
string
Ereignis-UUID.
calendar_id
string
UUID des Kalenders.
title
string
Titel des Ereignisses.
starts_at
string
Startzeit als ISO-8601-Datetime.
ends_at
string
Endzeit als ISO-8601-Datetime.
is_all_day
boolean
Gibt an, ob das Ereignis ganztagig ist.

Autorisierungen

Authorization
string
header
Standard:phk_your_api_key
erforderlich

Paste your Pharen API key without the Bearer prefix.

Abfrageparameter

range_start
string<date-time>

ISO 8601 datetime for the beginning of the event window.

Beispiel:

"2026-07-01T00:00:00Z"

range_end
string<date-time>

ISO 8601 datetime for the end of the event window. Must be after range_start.

Beispiel:

"2026-07-31T23:59:59Z"

team_id
string<uuid>

Team UUID for team-scoped keys.

Beispiel:

"1f5e2d4c-7a5b-45db-b61a-b7d42f3f94cc"

Antwort

Calendar events returned.

data
object[]
total
integer
Beispiel:

12

page
integer
Beispiel:

1

per_page
integer
Beispiel:

20