**גרסאות API** · **V2 (Latest)** · [V1](/integrations/v1/docs?lang=he)

# Events

OpenAPI 3.0.3 · API 2.0.0

```json
[
  {
    "url": "https://api.unisoft.world/integrations/v2",
    "description": "API"
  }
]
```

Read-only public events. The catalog includes posters, sessions and groups by site. The original events endpoints list standalone sessions. Scope: `events:read`.

## פעולות

## GET /events

List standalone events

`list_events`

Required scope: `events:read`. Lists the org's STANDALONE event sessions (« parcours d'événement »), each with its public form/donation links. Multi-session groups and system groups (e.g. Shabbat) are excluded. Ordered by start date, most recent first. Paginated.

### אימות

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### הרשאות נדרשות

```json
{
  "accepted": "events:read",
  "additional": []
}
```

### פרמטרים

```json
{
  "name": "limit",
  "in": "query",
  "schema": {
    "type": "integer",
    "minimum": 1,
    "maximum": 200,
    "default": 50
  },
  "description": "Number of results per page"
}
```

```json
{
  "name": "cursor",
  "in": "query",
  "schema": {
    "type": "string"
  },
  "description": "Opaque cursor returned by the previous request"
}
```

### תגובות

#### HTTP 200

```json
{
  "description": "OK",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Event"
            }
          },
          "meta": {
            "$ref": "#/components/schemas/Pagination"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "ERROR",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "error": {
            "type": "string",
            "example": "ERROR"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "error": {
            "type": "string",
            "example": "INSUFFICIENT_SCOPE"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "events:read",
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## GET /events/{id}

Get a standalone event

`get_event`

Required scope: `events:read`. Returns one standalone event by id (with its public links). 404 if it is not a standalone event of the org.

### אימות

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### הרשאות נדרשות

```json
{
  "accepted": "events:read",
  "additional": []
}
```

### פרמטרים

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
    "format": "uuid"
  },
  "description": "Identifier of the existing target resource, returned by its authorised list or read operation. Never generate a new UUID to address an existing record."
}
```

### תגובות

#### HTTP 200

```json
{
  "description": "OK",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "$ref": "#/components/schemas/Event"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "error": {
            "type": "string",
            "example": "NOT_FOUND"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "events:read",
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## GET /events/catalog

List the unified public event catalog

`list_event_catalog`

Required scope: `events:read`. Lists posters, standalone and grouped sessions, public groups and system groups visible on the selected site. Filter by kind or list a group's sessions using its groupId. Group dates span their sessions and a date filter matches a group if any session starts in the range. Sorted by start date, newest first, with undated entries last. Keep the filters when reusing a cursor.

### אימות

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### הרשאות נדרשות

```json
{
  "accepted": "events:read",
  "additional": []
}
```

### פרמטרים

```json
{
  "name": "virtualId",
  "in": "query",
  "schema": {
    "type": "string"
  },
  "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades."
}
```

```json
{
  "name": "limit",
  "in": "query",
  "schema": {
    "type": "integer",
    "minimum": 1,
    "maximum": 200,
    "default": 50
  },
  "description": "Number of results per page"
}
```

```json
{
  "name": "cursor",
  "in": "query",
  "schema": {
    "type": "string"
  },
  "description": "Opaque cursor returned by the previous request"
}
```

```json
{
  "name": "kind",
  "in": "query",
  "schema": {
    "type": "string",
    "enum": [
      "POSTER",
      "SESSION",
      "GROUP",
      "SYSTEM_GROUP"
    ]
  }
}
```

```json
{
  "name": "groupId",
  "in": "query",
  "schema": {
    "type": "string",
    "minLength": 1
  },
  "description": "Return sessions belonging to this group."
}
```

```json
{
  "name": "startsFrom",
  "in": "query",
  "schema": {
    "type": "string",
    "format": "date-time"
  },
  "description": "Include starts at or after this timestamp."
}
```

```json
{
  "name": "startsBefore",
  "in": "query",
  "schema": {
    "type": "string",
    "format": "date-time"
  },
  "description": "Include starts strictly before this timestamp."
}
```

### תגובות

#### HTTP 200

```json
{
  "description": "OK",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EventCatalogItem"
            }
          },
          "meta": {
            "$ref": "#/components/schemas/Pagination"
          }
        }
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_EVENT_KIND or INVALID_GROUP_ID or INVALID_DATE_RANGE or INVALID_CURSOR",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "error": {
            "type": "string",
            "example": "INVALID_EVENT_KIND or INVALID_GROUP_ID or INVALID_DATE_RANGE or INVALID_CURSOR"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "ERROR",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "error": {
            "type": "string",
            "example": "ERROR"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "error": {
            "type": "string",
            "example": "INSUFFICIENT_SCOPE"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "FACADE_NOT_FOUND",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "error": {
            "type": "string",
            "example": "FACADE_NOT_FOUND"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "events:read",
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## GET /events/catalog/{kind}/{id}

Get an item from the public event catalog

`get_event_catalog_item`

Required scope: `events:read`. Use kind and id from the catalog and the same virtualId. For a group, call list_event_catalog with its id as groupId to page through the sessions.

### אימות

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### הרשאות נדרשות

```json
{
  "accepted": "events:read",
  "additional": []
}
```

### פרמטרים

```json
{
  "name": "kind",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "enum": [
      "POSTER",
      "SESSION",
      "GROUP",
      "SYSTEM_GROUP"
    ]
  }
}
```

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string"
  },
  "description": "Item id returned by the event catalog."
}
```

```json
{
  "name": "virtualId",
  "in": "query",
  "schema": {
    "type": "string"
  },
  "description": "Façade (virtual site) to target. Omit = the main site. List façades with GET /site/facades."
}
```

### תגובות

#### HTTP 200

```json
{
  "description": "OK",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "$ref": "#/components/schemas/EventCatalogItem"
          }
        }
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_EVENT_KIND",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "error": {
            "type": "string",
            "example": "INVALID_EVENT_KIND"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "ERROR",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "error": {
            "type": "string",
            "example": "ERROR"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "error": {
            "type": "string",
            "example": "INSUFFICIENT_SCOPE"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND or FACADE_NOT_FOUND",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "error": {
            "type": "string",
            "example": "NOT_FOUND or FACADE_NOT_FOUND"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "events:read",
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## POST /events/{id}/communications/preview

Preview email communication to admitted event registrants

`preview_event_registrant_communication`

Pure preview: no campaign, journal, queue, CRM sync or provider effect. Supply explicit subject/message and inspect every native audience status. Pass the entire reviewed input plus expectedSnapshot unchanged to send. Preview requires only the cumulative read scopes and grants no send authority. Requires events:read, forms:read, forms_submit:read, contacts:read AND messages:read. Campaign-restricted keys are refused. One explicit formId must currently belong to the session. Only current VALIDE, unarchived, undeleted registrations with exact formData.id/organisation/pe snapshot attribution are admitted. Missing, foreign, scalar-array or contradictory references fail closed; no current-form fallback, CRM category or all-contact shortcut exists. The native form audience owner reads primary identity and typed contact/email fields, plus explicitly selected product participants. includePrimary defaults true and includeParticipants defaults false; both cannot be false. Current linked CRM coordinates replace the linked snapshot coordinates; distinct independent identity fields remain candidates. Native validation excludes deceased, invalid and unsubscribed addresses and deduplicates by normalized email, not by registration or person. excludedKeys can exclude an occurrence key or all occurrences of an email via its returned exclusion key. Use list_messaging_configs to identify the email sender without requesting credentials. Exactly one emailConfigId must reference a current organisation Email CONFIG; private credentials are never returned. Reads are bounded to 2000 admitted registrations, 2000 references/products, 20000 organisation unsubscribe records and 200 audience items including excluded/duplicate items; overflow refuses the whole operation. No query parameters are accepted. No reusable payment data or raw/private configuration appears in responses. This sends ordinary EMAIL communications only, with no payment operation, scheduling, fallback channel or implicit financial reminder. reservationStatus=COMPLETION_PROVEN requires a completion record written only after positive queue and terminal journal acknowledgements; a stored QUEUED alone never frees the resource. RETAINED keeps the reservation unavailable for a new command. A completion-bookkeeping failure does not erase a positively proven queue effect in the original response, queueAdmission=CONFIRMED preserves a positively acknowledged queue effect independently of terminal journal or completion bookkeeping. UNKNOWN never means failed. A later observation may show stored QUEUED without a completion marker; reservationStatus remains RETAINED and cannot authorize another command. 

### אימות

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### הרשאות נדרשות

```json
{
  "accepted": "events:read",
  "additional": [
    "forms:read",
    "forms_submit:read",
    "contacts:read",
    "messages:read"
  ]
}
```

### פרמטרים

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### גוף הבקשה

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "formId": {
            "type": "string",
            "format": "uuid"
          },
          "emailConfigId": {
            "type": "string",
            "format": "uuid"
          },
          "subject": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200,
            "pattern": "^[^\\r\\n]*\\S[^\\r\\n]*$"
          },
          "message": {
            "type": "string",
            "minLength": 1,
            "maxLength": 20000,
            "pattern": "\\S"
          },
          "includePrimary": {
            "type": "boolean"
          },
          "includeParticipants": {
            "type": "boolean"
          },
          "excludedKeys": {
            "type": "array",
            "maxItems": 200,
            "uniqueItems": true,
            "items": {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            }
          }
        },
        "required": [
          "formId",
          "emailConfigId",
          "subject",
          "message"
        ],
        "additionalProperties": false
      }
    }
  }
}
```

### תגובות

#### HTTP 200

```json
{
  "description": "Qualified event audience or recorded command observation.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/EventCommunicationPreview"
          }
        },
        "required": [
          "success",
          "data"
        ]
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_UUID, INVALID_EVENT_COMMUNICATION_INPUT, INVALID_REMINDER_INPUT or UNEXPECTED_REQUEST_BODY. Remove undeclared fields and query parameters.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Authentication is missing or invalid.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE, INVALID_PRINCIPAL or CAMPAIGN_RESTRICTED_KEY. Sending requires the explicit opt-in events:communications:send and messages:send in addition to every read scope.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND. An exact session, form, contact, sender configuration or same-principal command is unavailable.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "EVENT_COMMUNICATION_AUDIENCE_CHANGED requires a new preview and human review of the intended audience. EVENT_COMMUNICATION_AUDIENCE_EMPTY, EVENT_COMMUNICATION_ATTRIBUTION_UNPROVEN, EVENT_COMMUNICATION_SOURCE_UNPROVEN or EVENT_COMMUNICATION_SOURCE_LIMIT refuses incomplete or ambiguous sources. EVENT_COMMUNICATION_PREVIOUS_RESULT_UNKNOWN blocks a new command on the same session/form after an unresolved earlier result. IDEMPOTENCY_CONFLICT forbids reusing a request key for different input. No uncertain result authorizes retry.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 413

```json
{
  "description": "FORM_AUDIENCE_LIMIT. The canonical extraction limit of 20000 candidates or its bounded nested identity structure is exceeded. No partial audience, campaign or queue is created.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "INTERNAL_ERROR. A missing response leaves the result unknown; observe the existing request.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "REMINDER_JOURNAL_UNCERTAIN or EVENT_COMMUNICATION_RESERVATION_UNCERTAIN. A durable claim acknowledgement is missing or contradictory; no later effect is authorized. Observe the same request without changing its key.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "events:read",
  "x-unisoft-additional-scopes": [
    "forms:read",
    "forms_submit:read",
    "contacts:read",
    "messages:read"
  ],
  "x-unisoft-mcp-output-schema": true,
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## POST /events/{id}/communications/send

Queue an explicitly reviewed event registrant communication

`send_event_registrant_communication`

Requires explicit opt-in events:communications:send AND messages:send in addition to all read scopes. First preview the same form, sender, content and audience. Supply its exact expectedSnapshot and a new UUID idempotencyKey only for this genuinely new intention. A durable journal and exclusive session/form reservation precede campaign creation and insertMany. Every current form, registration, identity, unsubscribe and sender is readmitted after claiming and immediately before queueing. Concurrent later edits are not an atomic snapshot. The native CRM recipient renderer creates exact EMAIL queue documents under a native VALIDATE campaign. QUEUED requires acknowledged=true, exact inserted IDs and counts with explicit majority+journaled writes. PENDING/UNCERTAIN and queueRead=UNAVAILABLE never mean failed or delivered; observe the same request, never retry with another key. Unknown/partial effects retain the resource reservation and block new sends for that session/form. The same key/input returns the previous result without another effect; changed input gives IDEMPOTENCY_CONFLICT. QUEUED is queue admission only. SMTP_ACCEPTED is provider acceptance; DELIVERED requires a consistent explicit delivery report and deliveredAt. No provider polling or automatic replay occurs. Requires events:read, forms:read, forms_submit:read, contacts:read AND messages:read. Campaign-restricted keys are refused. One explicit formId must currently belong to the session. Only current VALIDE, unarchived, undeleted registrations with exact formData.id/organisation/pe snapshot attribution are admitted. Missing, foreign, scalar-array or contradictory references fail closed; no current-form fallback, CRM category or all-contact shortcut exists. The native form audience owner reads primary identity and typed contact/email fields, plus explicitly selected product participants. includePrimary defaults true and includeParticipants defaults false; both cannot be false. Current linked CRM coordinates replace the linked snapshot coordinates; distinct independent identity fields remain candidates. Native validation excludes deceased, invalid and unsubscribed addresses and deduplicates by normalized email, not by registration or person. excludedKeys can exclude an occurrence key or all occurrences of an email via its returned exclusion key. Use list_messaging_configs to identify the email sender without requesting credentials. Exactly one emailConfigId must reference a current organisation Email CONFIG; private credentials are never returned. Reads are bounded to 2000 admitted registrations, 2000 references/products, 20000 organisation unsubscribe records and 200 audience items including excluded/duplicate items; overflow refuses the whole operation. No query parameters are accepted. No reusable payment data or raw/private configuration appears in responses. This sends ordinary EMAIL communications only, with no payment operation, scheduling, fallback channel or implicit financial reminder. reservationStatus=COMPLETION_PROVEN requires a completion record written only after positive queue and terminal journal acknowledgements; a stored QUEUED alone never frees the resource. RETAINED keeps the reservation unavailable for a new command. A completion-bookkeeping failure does not erase a positively proven queue effect in the original response, queueAdmission=CONFIRMED preserves a positively acknowledged queue effect independently of terminal journal or completion bookkeeping. UNKNOWN never means failed. A later observation may show stored QUEUED without a completion marker; reservationStatus remains RETAINED and cannot authorize another command. Always empty. This placeholder provides no recipient status; observed queue evidence is available only in recipients and is qualified by queueRead and queueAdmission.

### אימות

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### הרשאות נדרשות

```json
{
  "accepted": "events:communications:send",
  "additional": [
    "events:read",
    "forms:read",
    "forms_submit:read",
    "contacts:read",
    "messages:read",
    "messages:send"
  ]
}
```

### פרמטרים

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### גוף הבקשה

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "formId": {
            "type": "string",
            "format": "uuid"
          },
          "emailConfigId": {
            "type": "string",
            "format": "uuid"
          },
          "subject": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200,
            "pattern": "^[^\\r\\n]*\\S[^\\r\\n]*$"
          },
          "message": {
            "type": "string",
            "minLength": 1,
            "maxLength": 20000,
            "pattern": "\\S"
          },
          "includePrimary": {
            "type": "boolean"
          },
          "includeParticipants": {
            "type": "boolean"
          },
          "excludedKeys": {
            "type": "array",
            "maxItems": 200,
            "uniqueItems": true,
            "items": {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            }
          },
          "idempotencyKey": {
            "type": "string",
            "format": "uuid"
          },
          "expectedSnapshot": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          }
        },
        "required": [
          "formId",
          "emailConfigId",
          "subject",
          "message",
          "idempotencyKey",
          "expectedSnapshot"
        ],
        "additionalProperties": false
      }
    }
  }
}
```

### תגובות

#### HTTP 200

```json
{
  "description": "Qualified event audience or recorded command observation.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/EventCommunicationCommand"
          }
        },
        "required": [
          "success",
          "data"
        ]
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_UUID, INVALID_EVENT_COMMUNICATION_INPUT, INVALID_REMINDER_INPUT or UNEXPECTED_REQUEST_BODY. Remove undeclared fields and query parameters.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Authentication is missing or invalid.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE, INVALID_PRINCIPAL or CAMPAIGN_RESTRICTED_KEY. Sending requires the explicit opt-in events:communications:send and messages:send in addition to every read scope.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND. An exact session, form, contact, sender configuration or same-principal command is unavailable.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "EVENT_COMMUNICATION_AUDIENCE_CHANGED requires a new preview and human review of the intended audience. EVENT_COMMUNICATION_AUDIENCE_EMPTY, EVENT_COMMUNICATION_ATTRIBUTION_UNPROVEN, EVENT_COMMUNICATION_SOURCE_UNPROVEN or EVENT_COMMUNICATION_SOURCE_LIMIT refuses incomplete or ambiguous sources. EVENT_COMMUNICATION_PREVIOUS_RESULT_UNKNOWN blocks a new command on the same session/form after an unresolved earlier result. IDEMPOTENCY_CONFLICT forbids reusing a request key for different input. No uncertain result authorizes retry.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 413

```json
{
  "description": "FORM_AUDIENCE_LIMIT. The canonical extraction limit of 20000 candidates or its bounded nested identity structure is exceeded. No partial audience, campaign or queue is created.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "INTERNAL_ERROR. A missing response leaves the result unknown; observe the existing request.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "REMINDER_JOURNAL_UNCERTAIN or EVENT_COMMUNICATION_RESERVATION_UNCERTAIN. A durable claim acknowledgement is missing or contradictory; no later effect is authorized. Observe the same request without changing its key.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "events:communications:send",
  "x-unisoft-additional-scopes": [
    "events:read",
    "forms:read",
    "forms_submit:read",
    "contacts:read",
    "messages:read",
    "messages:send"
  ],
  "x-unisoft-mcp-output-schema": true,
  "x-unisoft-mcp": {
    "category": "write",
    "readOnly": false,
    "destructive": false,
    "idempotent": true,
    "warn": true
  }
}
```

## GET /events/{id}/communications/commands/{requestId}

Observe an event communication command and current queue evidence

`get_event_registrant_communication_command`

Read-only observation for the same organisation and API principal as the request. Current session/form and linked queue contact references are readmitted. No nonempty request body is accepted. UNKNOWN or queueRead=UNAVAILABLE means the delivery evidence is unavailable; QUEUED_OR_IN_FLIGHT does not distinguish a waiting row from an active worker. SMTP_ACCEPTED is not inbox arrival. A command stays UNCERTAIN after missing/partial queue acknowledgement even if some queue rows can later be read. Observation never sends, polls a provider, releases an unresolved reservation or authorizes retry. Requires events:read, forms:read, forms_submit:read, contacts:read AND messages:read. Campaign-restricted keys are refused. One explicit formId must currently belong to the session. Only current VALIDE, unarchived, undeleted registrations with exact formData.id/organisation/pe snapshot attribution are admitted. Missing, foreign, scalar-array or contradictory references fail closed; no current-form fallback, CRM category or all-contact shortcut exists. The native form audience owner reads primary identity and typed contact/email fields, plus explicitly selected product participants. includePrimary defaults true and includeParticipants defaults false; both cannot be false. Current linked CRM coordinates replace the linked snapshot coordinates; distinct independent identity fields remain candidates. Native validation excludes deceased, invalid and unsubscribed addresses and deduplicates by normalized email, not by registration or person. excludedKeys can exclude an occurrence key or all occurrences of an email via its returned exclusion key. Use list_messaging_configs to identify the email sender without requesting credentials. Exactly one emailConfigId must reference a current organisation Email CONFIG; private credentials are never returned. Reads are bounded to 2000 admitted registrations, 2000 references/products, 20000 organisation unsubscribe records and 200 audience items including excluded/duplicate items; overflow refuses the whole operation. No query parameters are accepted. No reusable payment data or raw/private configuration appears in responses. This sends ordinary EMAIL communications only, with no payment operation, scheduling, fallback channel or implicit financial reminder. reservationStatus=COMPLETION_PROVEN requires a completion record written only after positive queue and terminal journal acknowledgements; a stored QUEUED alone never frees the resource. RETAINED keeps the reservation unavailable for a new command. A completion-bookkeeping failure does not erase a positively proven queue effect in the original response, queueAdmission=CONFIRMED preserves a positively acknowledged queue effect independently of terminal journal or completion bookkeeping. UNKNOWN never means failed. A later observation may show stored QUEUED without a completion marker; reservationStatus remains RETAINED and cannot authorize another command. Always empty. This placeholder provides no recipient status; observed queue evidence is available only in recipients and is qualified by queueRead and queueAdmission.

### אימות

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### הרשאות נדרשות

```json
{
  "accepted": "events:communications:send",
  "additional": [
    "events:read",
    "forms:read",
    "forms_submit:read",
    "contacts:read",
    "messages:read",
    "messages:send"
  ]
}
```

### פרמטרים

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

```json
{
  "name": "requestId",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### תגובות

#### HTTP 200

```json
{
  "description": "Qualified event audience or recorded command observation.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/EventCommunicationCommand"
          }
        },
        "required": [
          "success",
          "data"
        ]
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_UUID, INVALID_EVENT_COMMUNICATION_INPUT, INVALID_REMINDER_INPUT or UNEXPECTED_REQUEST_BODY. Remove undeclared fields and query parameters.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Authentication is missing or invalid.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE, INVALID_PRINCIPAL or CAMPAIGN_RESTRICTED_KEY. Sending requires the explicit opt-in events:communications:send and messages:send in addition to every read scope.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND. An exact session, form, contact, sender configuration or same-principal command is unavailable.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "EVENT_COMMUNICATION_AUDIENCE_CHANGED requires a new preview and human review of the intended audience. EVENT_COMMUNICATION_AUDIENCE_EMPTY, EVENT_COMMUNICATION_ATTRIBUTION_UNPROVEN, EVENT_COMMUNICATION_SOURCE_UNPROVEN or EVENT_COMMUNICATION_SOURCE_LIMIT refuses incomplete or ambiguous sources. EVENT_COMMUNICATION_PREVIOUS_RESULT_UNKNOWN blocks a new command on the same session/form after an unresolved earlier result. IDEMPOTENCY_CONFLICT forbids reusing a request key for different input. No uncertain result authorizes retry.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 413

```json
{
  "description": "FORM_AUDIENCE_LIMIT. The canonical extraction limit of 20000 candidates or its bounded nested identity structure is exceeded. No partial audience, campaign or queue is created.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "INTERNAL_ERROR. A missing response leaves the result unknown; observe the existing request.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

#### HTTP 503

```json
{
  "description": "REMINDER_JOURNAL_UNCERTAIN or EVENT_COMMUNICATION_RESERVATION_UNCERTAIN. A durable claim acknowledgement is missing or contradictory; no later effect is authorized. Observe the same request without changing its key.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        },
        "required": [
          "success",
          "error"
        ]
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "events:communications:send",
  "x-unisoft-additional-scopes": [
    "events:read",
    "forms:read",
    "forms_submit:read",
    "contacts:read",
    "messages:read",
    "messages:send"
  ],
  "x-unisoft-mcp-output-schema": true,
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## GET /events/{id}/finance

Read qualified registration finances by session, association and currency

`get_event_session_finance`

Requires events:read, forms:read, forms_submit:read AND paiements:read. Campaign-restricted keys are refused because session/form registrations have no independent campaign membership owner. Read-only: no charge, refund, reconciliation, cache or persistent schedule changes. This is REGISTRATION_FINANCE_ONLY, not a complete event budget, profit or bank statement. Session attribution comes from the CURRENT RECORDED registration formData.pe snapshot, with exact snapshot form/organisation and payment FORM -> registration plus parentTypeId -> form. Never fall back to the form current pe when a snapshot is missing. Ordinary submission editing preserves the snapshot; accepted custom-price repricing can replace it, so this is not an immutable historical event ledger. A current form moved to another session does not reattribute a valid stored snapshot. Every interpreted session/form/registration/payment/subscription is reauthorized in the organisation; stale, deleted, missing, foreign, scalar-array or contradictory relations are refused rather than silently omitted. Cross-pledge allocation maps require a dedicated owner and are refused, including an explicit empty map. Groups stay separate by association and recorded currency; no currency default, conversion or cross-group total is supplied. Monetary fields use minor units (5000 = 50.00 EUR); forms_submit.total is already minor. Accepted commitment includes only current VALIDE, unarchived registrations. Payment activity includes all admitted registration states/archive statuses; imported COMPLETED records are included, unlike monetary budget totals. completedAmountMinor counts current monetary COMPLETED results, not bank settlement; an Axepta authorization may precede capture. recordedRefundedAmountMinor is the whole amount of REFUNDED with a consistent recorded SUCCEEDED refund, not proof of bank credit. REFUND_PENDING or unknown refund state leaves retainedRecordedMinor and the affected acceptedOutstandingMinor null, never zero. Unknown/nonterminal attempts similarly make retained/outstanding unavailable; their nominal amount is not a payment received. In-kind NATURE amounts are separate nominal observations, not money. The canonical registration owner computes remaining accepted commitment per registration, clamped at zero; an overpayment does not settle another registration. netAfterFeesMinor is available only for known retained records with explicit zero bank/service fees; nonzero fee currency/provenance or missing fee fields leaves it null. profitMinor is always null because expenses/profit and historical pot attribution are unavailable facets. An empty admitted population returns groups=[], without inventing EUR or a zero complete budget. Reads are bounded to 500 admitted forms, 10000 candidate registrations, 10000 payment records, 200 currency/association groups, 500 related sessions and 500 related subscriptions; overflow returns EVENT_FINANCIAL_SOURCE_LIMIT rather than partial totals. Separate reads are not an atomic snapshot. No query parameters or nonempty request body are accepted. No donor identity, receipt snapshot, reusable payment method, provider reference, raw error or private configuration is returned.

### אימות

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### הרשאות נדרשות

```json
{
  "accepted": "events:read",
  "additional": [
    "forms:read",
    "forms_submit:read",
    "paiements:read"
  ]
}
```

### פרמטרים

```json
{
  "name": "id",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "format": "uuid"
  }
}
```

### תגובות

#### HTTP 200

```json
{
  "description": "Recorded registration-finance groups with explicit unavailable facets.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/EventFinanceObservation"
          }
        }
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "INVALID_UUID, INVALID_REMINDER_INPUT or UNEXPECTED_REQUEST_BODY. Remove unsupported query/body inputs.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid authentication.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "INSUFFICIENT_SCOPE, INVALID_PRINCIPAL or CAMPAIGN_RESTRICTED_KEY.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "NOT_FOUND: an interpreted session, form, registration or subscription is missing, deleted, foreign or ambiguous.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "EVENT_ATTRIBUTION_SNAPSHOT_REQUIRED, EVENT_FINANCIAL_ATTRIBUTION_UNPROVEN, EVENT_PAYMENT_ATTRIBUTION_UNPROVEN, EVENT_FINANCIAL_DENOMINATION_UNPROVEN, EVENT_FINANCIAL_ASSOCIATION_UNAVAILABLE, EVENT_CROSS_ALLOCATION_REVIEW_REQUIRED, EVENT_PAYMENT_INSTRUMENT_UNVERIFIED, EVENT_FINANCIAL_HISTORY_INVALID, EVENT_FINANCIAL_AMOUNT_OVERFLOW or EVENT_FINANCIAL_SOURCE_LIMIT. Review the owning records; no default currency, current-session fallback or partial total is returned.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "INTERNAL_ERROR. No partial financial result is returned.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-mcp-output-schema": true,
  "x-unisoft-scope": "events:read",
  "x-unisoft-additional-scopes": [
    "forms:read",
    "forms_submit:read",
    "paiements:read"
  ],
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## GET /events/calendar

Discover the public event-calendar subscription URL

`get_event_calendar`

Requires events:read on an unrestricted organisation connection. Returns the public feed URL and its current coverage/diagnostics; it does not subscribe the user, create a calendar token or change any business record. The URL can be used directly by a calendar application without an API key. Public iCalendar feed of the selected organisation and main site or exact facade. Only the existing canonical public-event catalogue is read: public posters and actual standalone/group sessions, including the authorised site Shabbat sessions. Synthetic group cards are not calendar occurrences, so groups and their sessions are not duplicated. UID is stable by environment, organisation, facade, event kind and source id; a changed date/title retains that UID. Instants are emitted in UTC from unambiguous stored dates; religious times are never computed. Poster dateFin is a display boundary and is never used as an event end. No default date window or pagination silently hides events: at most 5000 occurrences, 10000 source rows and 8388608 calendar bytes are admitted, otherwise the whole response is refused. Entries with no recorded start are excluded with an explicit count; nonempty ambiguous dates or conflicting historical references refuse the whole response. The response is a current complete dated-public snapshot within any explicit start filters. Withdrawn/unpublished entries disappear on refresh; there is no persisted cancellation journal, tombstone history or guarantee that a particular calendar client removes an absent item. Client polling determines update timing. No attendees, CRM identities, responses, donor records, reusable credentials, private calendar token or registration/payment action is exposed.

### אימות

```json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyHeader": []
  }
]
```

### הרשאות נדרשות

```json
{
  "accepted": "events:read",
  "additional": []
}
```

### פרמטרים

```json
{
  "name": "virtualId",
  "in": "query",
  "schema": {
    "type": "string",
    "pattern": "^[A-Za-z0-9_-]{1,128}$"
  },
  "description": "Existing facade of this organisation. Omission selects the main public site; it never selects the first facade."
}
```

```json
{
  "name": "lang",
  "in": "query",
  "schema": {
    "type": "string",
    "pattern": "^[a-z]{2}$"
  },
  "description": "Enabled content language. Omission uses the organisation default. A missing translated field falls back to its root value."
}
```

```json
{
  "name": "from",
  "in": "query",
  "schema": {
    "type": "string",
    "format": "date-time"
  },
  "description": "Optional inclusive start-instant filter, with explicit timezone. No implicit rolling window is applied."
}
```

```json
{
  "name": "to",
  "in": "query",
  "schema": {
    "type": "string",
    "format": "date-time"
  },
  "description": "Optional exclusive start-instant filter, with explicit timezone. When both bounds are supplied, from must precede to."
}
```

### תגובות

#### HTTP 200

```json
{
  "description": "Public URL and current snapshot coverage, not a completed client subscription.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/EventCalendarDiscoveryResponse"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "Invalid calendar options, timezone-qualified range or disabled language. No business effect occurs.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 401

```json
{
  "description": "Missing or invalid API key.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 403

```json
{
  "description": "Missing events:read scope or campaign-restricted connection.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "Organisation or facade unavailable. No private organisation data is returned.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "Source/date ambiguity, concurrent source change, unavailable site URL or volume ceiling. The entire feed is refused; it is never silently truncated.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "The public calendar could not be read. No subscription, publication or financial action was performed.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": "events:read",
  "x-unisoft-mcp-output-schema": true,
  "x-unisoft-mcp": {
    "category": "read",
    "readOnly": true,
    "destructive": false,
    "idempotent": true,
    "warn": false
  }
}
```

## GET /events/calendar/{organisationId}.ics

Read the public event calendar as iCalendar

`download_public_event_calendar`

Public iCalendar feed of the selected organisation and main site or exact facade. Only the existing canonical public-event catalogue is read: public posters and actual standalone/group sessions, including the authorised site Shabbat sessions. Synthetic group cards are not calendar occurrences, so groups and their sessions are not duplicated. UID is stable by environment, organisation, facade, event kind and source id; a changed date/title retains that UID. Instants are emitted in UTC from unambiguous stored dates; religious times are never computed. Poster dateFin is a display boundary and is never used as an event end. No default date window or pagination silently hides events: at most 5000 occurrences, 10000 source rows and 8388608 calendar bytes are admitted, otherwise the whole response is refused. Entries with no recorded start are excluded with an explicit count; nonempty ambiguous dates or conflicting historical references refuse the whole response. The response is a current complete dated-public snapshot within any explicit start filters. Withdrawn/unpublished entries disappear on refresh; there is no persisted cancellation journal, tombstone history or guarantee that a particular calendar client removes an absent item. Client polling determines update timing. No attendees, CRM identities, responses, donor records, reusable credentials, private calendar token or registration/payment action is exposed.

### אימות

```json
[]
```

### הרשאות נדרשות

```json
{
  "accepted": null,
  "additional": []
}
```

### פרמטרים

```json
{
  "name": "organisationId",
  "in": "path",
  "required": true,
  "schema": {
    "type": "string",
    "pattern": "^[A-Za-z0-9_-]{1,128}$"
  },
  "description": "Canonical organisation identifier, not a domain, API key or private calendar token."
}
```

```json
{
  "name": "virtualId",
  "in": "query",
  "schema": {
    "type": "string",
    "pattern": "^[A-Za-z0-9_-]{1,128}$"
  },
  "description": "Existing facade of this organisation. Omission selects the main public site; it never selects the first facade."
}
```

```json
{
  "name": "lang",
  "in": "query",
  "schema": {
    "type": "string",
    "pattern": "^[a-z]{2}$"
  },
  "description": "Enabled content language. Omission uses the organisation default. A missing translated field falls back to its root value."
}
```

```json
{
  "name": "from",
  "in": "query",
  "schema": {
    "type": "string",
    "format": "date-time"
  },
  "description": "Optional inclusive start-instant filter, with explicit timezone. No implicit rolling window is applied."
}
```

```json
{
  "name": "to",
  "in": "query",
  "schema": {
    "type": "string",
    "format": "date-time"
  },
  "description": "Optional exclusive start-instant filter, with explicit timezone. When both bounds are supplied, from must precede to."
}
```

### תגובות

#### HTTP 200

```json
{
  "description": "Complete dated-public iCalendar snapshot. X-Unisoft-Calendar-Event-Count and X-Unisoft-Calendar-Excluded-Undated qualify the content.",
  "headers": {
    "X-Unisoft-Calendar-Event-Count": {
      "schema": {
        "type": "integer",
        "minimum": 0
      }
    },
    "X-Unisoft-Calendar-Excluded-Undated": {
      "schema": {
        "type": "integer",
        "minimum": 0
      }
    },
    "X-Unisoft-Calendar-Deletion-Mode": {
      "schema": {
        "type": "string",
        "enum": [
          "CURRENT_SNAPSHOT"
        ]
      }
    }
  },
  "content": {
    "text/calendar": {
      "schema": {
        "type": "string"
      }
    }
  }
}
```

#### HTTP 400

```json
{
  "description": "Invalid calendar options, timezone-qualified range or disabled language. No business effect occurs.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 404

```json
{
  "description": "Organisation or facade unavailable. No private organisation data is returned.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 409

```json
{
  "description": "Source/date ambiguity, concurrent source change, unavailable site URL or volume ceiling. The entire feed is refused; it is never silently truncated.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

#### HTTP 500

```json
{
  "description": "The public calendar could not be read. No subscription, publication or financial action was performed.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "error"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "error": {
            "type": "string"
          }
        }
      }
    }
  }
}
```

### OpenAPI

```json
{
  "x-unisoft-scope": null,
  "x-unisoft-mcp": false
}
```

## סכמות

```json
{
  "components": {
    "schemas": {
      "Event": {
        "type": "object",
        "description": "A standalone event session (« parcours d'événement »): a dated occasion visitors can register for or pay into. Read-only — events (with their forms, pots and budget booklets) are created in the admin app. Multi-session event groups and system groups (e.g. Shabbat, exposed under the Travel API) are NOT listed here. Localised string fields carry the default language at the root, with optional per-language overlays (`fr`/`en`/`he`/`de`/`gr`…).",
        "properties": {
          "id": {
            "type": "string",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "nullable": true,
            "readOnly": true,
            "description": "Public title of the session."
          },
          "description": {
            "type": "string",
            "nullable": true,
            "readOnly": true
          },
          "dateEvent": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "description": "Start date/time."
          },
          "dateFin": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "description": "End date/time."
          },
          "dateDebut": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "readOnly": true,
            "description": "Date from which the event becomes visible."
          },
          "image": {
            "type": "string",
            "nullable": true,
            "readOnly": true,
            "description": "Poster/illustration (hosted filename or URL)."
          },
          "adresse": {
            "type": "string",
            "nullable": true,
            "readOnly": true,
            "description": "Venue address, when set."
          },
          "links": {
            "type": "array",
            "readOnly": true,
            "items": {
              "$ref": "#/components/schemas/EventLink"
            },
            "description": "Active registration forms + donation pots for this event."
          }
        }
      },
      "EventLink": {
        "type": "object",
        "description": "A public action link for the event (a registration form or a donation pot).",
        "properties": {
          "name": {
            "type": "string",
            "readOnly": true,
            "description": "Link label (localised; see per-language overlays)."
          },
          "url": {
            "type": "string",
            "readOnly": true,
            "description": "Public URL (a /form/… or /don/… page)."
          }
        }
      },
      "Pagination": {
        "type": "object",
        "properties": {
          "nextCursor": {
            "type": "string",
            "nullable": true
          },
          "hasMore": {
            "type": "boolean"
          },
          "count": {
            "type": "integer"
          }
        }
      },
      "EventCatalogItem": {
        "type": "object",
        "required": [
          "id",
          "kind",
          "groupId",
          "name",
          "description",
          "image",
          "adresse",
          "dateEvent",
          "dateFin",
          "links",
          "i18n"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "kind": {
            "type": "string",
            "enum": [
              "POSTER",
              "SESSION",
              "GROUP",
              "SYSTEM_GROUP"
            ]
          },
          "groupId": {
            "type": "string",
            "nullable": true,
            "description": "Parent group id for a grouped session, otherwise null."
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "image": {
            "type": "string",
            "nullable": true
          },
          "adresse": {
            "type": "string",
            "nullable": true
          },
          "dateEvent": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "dateFin": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "links": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EventCatalogLink"
            }
          },
          "i18n": {
            "type": "object",
            "additionalProperties": {
              "type": "object",
              "additionalProperties": {
                "type": "string"
              }
            }
          },
          "sessionsCount": {
            "type": "integer",
            "minimum": 0,
            "description": "Total number of sessions for a group before date filtering."
          },
          "extension": {
            "type": "string",
            "description": "Module identifier for a system group, such as a Shabbat group."
          }
        }
      },
      "EventCatalogLink": {
        "type": "object",
        "required": [
          "name",
          "url",
          "i18n"
        ],
        "properties": {
          "name": {
            "type": "string",
            "nullable": true
          },
          "url": {
            "type": "string"
          },
          "kind": {
            "type": "string",
            "enum": [
              "registration",
              "fundraising"
            ]
          },
          "targetId": {
            "type": "string",
            "description": "For a generated link to a verified resource owned by this organisation and session, the id to use with /forms or /caisses according to kind. Editorial links omit kind and targetId, even when their URL copies a resource URL."
          },
          "i18n": {
            "type": "object",
            "additionalProperties": {
              "type": "object",
              "additionalProperties": {
                "type": "string"
              }
            }
          }
        }
      },
      "EventCommunicationPreview": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "sessionId": {
            "type": "string",
            "format": "uuid"
          },
          "formId": {
            "type": "string",
            "format": "uuid"
          },
          "emailConfigId": {
            "type": "string",
            "format": "uuid"
          },
          "channel": {
            "type": "string",
            "enum": [
              "EMAIL"
            ]
          },
          "expectedSnapshot": {
            "type": "string",
            "pattern": "^[a-f0-9]{64}$"
          },
          "submissionCount": {
            "type": "integer",
            "minimum": 0
          },
          "summary": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "total": {
                "type": "integer",
                "minimum": 0
              },
              "reachable": {
                "type": "integer",
                "minimum": 0
              },
              "duplicates": {
                "type": "integer",
                "minimum": 0
              },
              "excluded": {
                "type": "integer",
                "minimum": 0
              },
              "unavailable": {
                "type": "integer",
                "minimum": 0
              },
              "unsubscribed": {
                "type": "integer",
                "minimum": 0
              }
            },
            "required": [
              "total",
              "reachable",
              "duplicates",
              "excluded",
              "unavailable",
              "unsubscribed"
            ]
          },
          "includePrimary": {
            "type": "boolean"
          },
          "includeParticipants": {
            "type": "boolean"
          },
          "subject": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "recipients": {
            "type": "array",
            "maxItems": 200,
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "key": {
                  "type": "string",
                  "pattern": "^[a-f0-9]{64}$"
                },
                "email": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "ready",
                    "duplicates",
                    "excluded",
                    "unavailable",
                    "unsubscribed"
                  ]
                },
                "submissionId": {
                  "type": "string",
                  "format": "uuid"
                },
                "kind": {
                  "type": "string",
                  "enum": [
                    "primary",
                    "participant"
                  ]
                },
                "exclusionKeys": {
                  "type": "array",
                  "maxItems": 2,
                  "items": {
                    "type": "string",
                    "pattern": "^[a-f0-9]{64}$"
                  }
                }
              },
              "required": [
                "key",
                "email",
                "name",
                "status",
                "submissionId",
                "kind",
                "exclusionKeys"
              ]
            }
          },
          "limits": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "maxSubmissions": {
                "type": "integer",
                "enum": [
                  2000
                ]
              },
              "maxAudienceItems": {
                "type": "integer",
                "enum": [
                  200
                ]
              }
            },
            "required": [
              "maxSubmissions",
              "maxAudienceItems"
            ]
          },
          "previewOnly": {
            "type": "boolean",
            "enum": [
              true
            ]
          }
        },
        "required": [
          "sessionId",
          "formId",
          "emailConfigId",
          "channel",
          "expectedSnapshot",
          "submissionCount",
          "summary",
          "includePrimary",
          "includeParticipants",
          "subject",
          "message",
          "recipients",
          "limits",
          "previewOnly"
        ]
      },
      "EventCommunicationCommand": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "requestId": {
            "type": "string",
            "format": "uuid"
          },
          "action": {
            "type": "string",
            "enum": [
              "SEND"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "PENDING",
              "QUEUED",
              "UNCERTAIN"
            ]
          },
          "requestedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "completedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "targetIds": {
            "type": "array",
            "minItems": 2,
            "maxItems": 2,
            "items": {
              "type": "string",
              "format": "uuid"
            }
          },
          "error": {
            "type": "string",
            "nullable": true
          },
          "outcomes": {
            "type": "array",
            "minItems": 0,
            "maxItems": 0,
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {}
            },
            "description": "Always empty. This placeholder provides no recipient status; observed queue evidence is available only in recipients and is qualified by queueRead and queueAdmission."
          },
          "retryable": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "sessionId": {
            "type": "string",
            "format": "uuid"
          },
          "formId": {
            "type": "string",
            "format": "uuid"
          },
          "campaignId": {
            "type": "string",
            "format": "uuid"
          },
          "reservationStatus": {
            "type": "string",
            "enum": [
              "COMPLETION_PROVEN",
              "RETAINED"
            ]
          },
          "queueAdmission": {
            "type": "string",
            "enum": [
              "CONFIRMED",
              "UNKNOWN"
            ]
          },
          "queueRead": {
            "type": "string",
            "enum": [
              "AVAILABLE",
              "UNAVAILABLE"
            ]
          },
          "recipients": {
            "type": "array",
            "maxItems": 200,
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "sendId": {
                  "type": "string",
                  "format": "uuid"
                },
                "state": {
                  "type": "string",
                  "enum": [
                    "QUEUED_OR_IN_FLIGHT",
                    "SMTP_ACCEPTED",
                    "DELIVERED",
                    "FAILED",
                    "CANCELED",
                    "UNKNOWN"
                  ]
                }
              },
              "required": [
                "sendId",
                "state"
              ]
            }
          }
        },
        "required": [
          "requestId",
          "action",
          "status",
          "requestedAt",
          "completedAt",
          "targetIds",
          "error",
          "outcomes",
          "retryable",
          "sessionId",
          "formId",
          "campaignId",
          "reservationStatus",
          "queueAdmission",
          "queueRead",
          "recipients"
        ]
      },
      "EventFinanceObservation": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "sessionId",
          "observedAt",
          "unit",
          "attribution",
          "coverage",
          "groups",
          "snapshot",
          "unavailableFacets",
          "limits",
          "registrationCount",
          "paymentCount",
          "excludedCurrentFormSubmissionsWithOtherSnapshot"
        ],
        "properties": {
          "sessionId": {
            "type": "string",
            "format": "uuid"
          },
          "observedAt": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "unit": {
            "type": "string",
            "enum": [
              "MINOR"
            ]
          },
          "attribution": {
            "type": "string",
            "enum": [
              "REGISTRATION_FORM_SNAPSHOT"
            ]
          },
          "coverage": {
            "type": "string",
            "enum": [
              "REGISTRATION_FINANCE_ONLY"
            ]
          },
          "groups": {
            "type": "array",
            "maxItems": 200,
            "items": {
              "$ref": "#/components/schemas/EventFinanceCurrencyGroup"
            }
          },
          "snapshot": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "unavailableFacets": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "POT_HISTORICAL_SESSION_ATTRIBUTION",
                "EXPENSES_AND_PROFIT",
                "BANK_SETTLEMENT_VERIFICATION"
              ]
            }
          },
          "limits": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "maxForms",
              "maxSubmissions",
              "maxPayments",
              "maxGroups",
              "maxRelatedSessions",
              "maxSubscriptions"
            ],
            "properties": {
              "maxForms": {
                "type": "integer",
                "enum": [
                  500
                ]
              },
              "maxSubmissions": {
                "type": "integer",
                "enum": [
                  10000
                ]
              },
              "maxPayments": {
                "type": "integer",
                "enum": [
                  10000
                ]
              },
              "maxGroups": {
                "type": "integer",
                "enum": [
                  200
                ]
              },
              "maxRelatedSessions": {
                "type": "integer",
                "enum": [
                  500
                ]
              },
              "maxSubscriptions": {
                "type": "integer",
                "enum": [
                  500
                ]
              }
            }
          },
          "registrationCount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "paymentCount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "excludedCurrentFormSubmissionsWithOtherSnapshot": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        }
      },
      "EventFinanceCurrencyGroup": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "assoc",
          "currency",
          "registrationCount",
          "acceptedRegistrationCount",
          "acceptedCommitmentMinor",
          "completedPaymentCount",
          "completedAmountMinor",
          "recordedRefundedPaymentCount",
          "recordedRefundedAmountMinor",
          "pendingRefundPaymentCount",
          "pendingRefundAmountMinor",
          "unresolvedAttemptCount",
          "unresolvedAttemptAmountMinor",
          "inKindPaymentCount",
          "inKindNominalAmountMinor",
          "importedCompletedPaymentCount",
          "retainedRecordedMinor",
          "acceptedOutstandingMinor",
          "netAfterFeesMinor",
          "profitMinor",
          "availability",
          "unavailableReasons"
        ],
        "properties": {
          "assoc": {
            "type": "string"
          },
          "currency": {
            "type": "string",
            "pattern": "^[a-z]{3}$"
          },
          "registrationCount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "acceptedRegistrationCount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "acceptedCommitmentMinor": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "completedPaymentCount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "completedAmountMinor": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "recordedRefundedPaymentCount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "recordedRefundedAmountMinor": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "pendingRefundPaymentCount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "pendingRefundAmountMinor": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "unresolvedAttemptCount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "unresolvedAttemptAmountMinor": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "inKindPaymentCount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "inKindNominalAmountMinor": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "importedCompletedPaymentCount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "retainedRecordedMinor": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991,
            "nullable": true
          },
          "acceptedOutstandingMinor": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991,
            "nullable": true
          },
          "netAfterFeesMinor": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991,
            "nullable": true
          },
          "profitMinor": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991,
            "nullable": true,
            "enum": [
              null
            ]
          },
          "availability": {
            "type": "string",
            "enum": [
              "QUALIFIED",
              "RECORDED_AMOUNTS_AVAILABLE"
            ]
          },
          "unavailableReasons": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "REFUND_RESULT_UNCONFIRMED",
                "PAYMENT_RESULT_UNCONFIRMED",
                "NON_MONETARY_PAYMENT",
                "FEE_CURRENCY_UNPROVEN",
                "FEE_AMOUNT_UNAVAILABLE"
              ]
            }
          }
        }
      },
      "EventCalendarDiscoveryResponse": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "success",
          "data"
        ],
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "data": {
            "$ref": "#/components/schemas/EventCalendarDiscovery"
          }
        }
      },
      "EventCalendarDiscovery": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "url",
          "format",
          "access",
          "organisationId",
          "virtualId",
          "language",
          "readAt",
          "eventCount",
          "excludedUndated",
          "from",
          "to",
          "coverage",
          "maxEvents",
          "maxSourceRows",
          "maxCalendarBytes",
          "calendarBytes",
          "deletionMode",
          "historyAvailable"
        ],
        "properties": {
          "url": {
            "type": "string",
            "format": "uri",
            "description": "Public iCalendar subscription URL. Contains no API key, account token or donor data. Adding this URL to a calendar client is a separate client action."
          },
          "format": {
            "type": "string",
            "enum": [
              "ICALENDAR"
            ]
          },
          "access": {
            "type": "string",
            "enum": [
              "PUBLIC"
            ]
          },
          "organisationId": {
            "type": "string"
          },
          "virtualId": {
            "type": "string",
            "nullable": true
          },
          "language": {
            "type": "string"
          },
          "readAt": {
            "type": "string",
            "format": "date-time"
          },
          "eventCount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 5000
          },
          "excludedUndated": {
            "type": "integer",
            "minimum": 0,
            "description": "Current public entries without a recorded start. They cannot become calendar occurrences; no current time or all-day date is fabricated."
          },
          "from": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "to": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "coverage": {
            "type": "string",
            "enum": [
              "CURRENT_PUBLIC_DATED_EVENTS"
            ]
          },
          "maxEvents": {
            "type": "integer",
            "enum": [
              5000
            ]
          },
          "maxSourceRows": {
            "type": "integer",
            "enum": [
              10000
            ]
          },
          "maxCalendarBytes": {
            "type": "integer",
            "enum": [
              8388608
            ]
          },
          "calendarBytes": {
            "type": "integer",
            "minimum": 0,
            "maximum": 8388608
          },
          "deletionMode": {
            "type": "string",
            "enum": [
              "CURRENT_SNAPSHOT"
            ]
          },
          "historyAvailable": {
            "type": "boolean",
            "enum": [
              false
            ]
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "API Key",
        "description": "Format: `ke_live_xxx`"
      },
      "apiKeyHeader": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key"
      }
    }
  }
}
```
