Topolo Docs Topolo Platform
Open workspace

Export organization Calendar data — Calendar

Export Calendar-owned records for the authenticated organization.

Export Calendar-owned records for the authenticated organization.

Action: app_topolo_calendar.privacy.export · GET /api/privacy

Declared permission: app_topolo_calendar.privacy:read. For authorized Calendar users; permissions and resource access still apply.

Before you start

  • Use the current credential to confirm the production organization and inspect this exact action before preparing a call.
  • Declared permission: app_topolo_calendar.privacy:read. Permission discovery is not a grant.
  • The target is the authenticated organization across its Calendar-owned workspaces; a resource selector does not reduce the operation to one workspace.

Inputs and field meanings

No action input fields. Supply the empty JSON object {}; keep resource context separate.

Worked request and response

Source-reviewed illustration only. Nothing below was executed; all identifiers, counts, states, credentials and URLs are synthetic. Replace identifiers through discovery before any separately authorized call.

Resource context: organization; it is not an extra action input field.

Illustrative action input:

{}

Illustrative HTTP 200 source response:

{
  "export": {
    "organization_id": "org_example",
    "exported_at": "2026-11-01T00:00:00.000Z",
    "stores": {
      "workspaces": [],
      "hosts": [],
      "event_types": [],
      "availability_rules": [],
      "availability_overrides": [],
      "bookings": [],
      "booking_attendees": [],
      "slot_holds": [],
      "external_calendars": [],
      "external_calendar_oauth_states": [],
      "external_busy_blocks": [],
      "recurrence_series": [],
      "recurrence_exceptions": [],
      "avatar_objects": []
    },
    "total": 0
  }
}

This empty-organization illustration has total 0 and empty named stores. A real export may contain personal data even after credential-like fields are redacted. Its scope is the authenticated organization, not only the selected workspace.

The illustrative response passes the declared structural schema. This establishes only schema compatibility, not deployed shape, values, authorization or business outcome.

Effects and verification

  • Reads and decrypts supported Calendar-owned organization records, redacts credential-like fields and inventories avatar objects.
  1. Confirm export.organization_id and the returned store counts; handle contents in the authorized secure destination.

Refusals and recovery

Selected source refusals are listed below; runtime middleware can return additional structured errors.

HTTPErrorSupported response
403forbiddenReconcile the declared permission, organization and verified resource grant with the legitimate access owner; do not switch context to bypass a refusal.

Recovery: This read does not mutate Calendar records. Correct the selected context or request fields before another authorized read.

  • app_topolo_calendar.privacy.erase: Permanently erase Calendar-owned data across an organization.

Declared schemas and provenance

The hidden action guide carries these exact current declared schemas. They are not rewritten to make the illustrations pass.

Input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Output schema:

{
  "type": "object",
  "title": "Export organization Calendar data response",
  "description": "Operation result returned by privacy.export.",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "id": {
      "type": "string"
    },
    "data": {
      "oneOf": [
        {
          "type": "object",
          "title": "privacy record",
          "properties": {
            "id": {
              "type": "string",
              "description": "Stable identifier when the privacy exposes one."
            }
          },
          "additionalProperties": true
        },
        {
          "type": "object",
          "additionalProperties": true
        }
      ]
    },
    "result": {
      "type": "object",
      "additionalProperties": true
    },
    "message": {
      "type": "string"
    }
  },
  "additionalProperties": true,
  "x-topolo-contract-source": "derived-action-metadata",
  "x-topolo-contract-precision": "structural"
}

Source: TopoloCalendar@b378ceb73800ee1d1e6c4ff6f0b4179918cf632c, apps/api/src/routes/privacy.ts. Current catalog metadata and source were compared without executing the application.

  • Source-reviewed synthetic input/response; not captured or executed.
  • Source revision is not proof of current deployment, caller access, provider connection or notification delivery.
  • The illustrative response passes the declared structural schema. This establishes only schema compatibility, not deployed shape, values, authorization or business outcome.