Discover date override IDs before updating or deleting one.
Action: app_topolo_calendar.availability.overrides.list · GET /api/admin/availability/overrides
Declared permission: app_topolo_calendar.availability:read. For authorized Calendar users; permissions and resource access still apply.
Before you start
- Use the current credential to confirm the production organization and inspect this exact action before preparing a call.
- Declared permission: app_topolo_calendar.availability:read. Permission discovery is not a grant.
- Discover the authorized Calendar workspace and pass it as resourceType=workspace/resourceId separately from this action input. Calendar records and IDs are scoped to the selected host/workspace.
Inputs and field meanings
No action input fields. Supply the empty JSON object {}; keep resource context separate.
Worked request and response
Source-reviewed illustration only. Nothing below was executed; all identifiers, counts, states, credentials and URLs are synthetic. Replace identifiers through discovery before any separately authorized call.
Resource context: workspace; it is not an extra action input field.
Illustrative action input:
{}
Illustrative HTTP 200 source response:
{
"overrides": [
{
"id": "ovr_example",
"hostId": "hst_example",
"date": "2026-11-20",
"startMinute": null,
"endMinute": null
}
]
}
Each override has its own id. A date alone is not the update identity. Null startMinute/endMinute mean a closed day; compare dates in the host timezone.
The illustrative response passes the declared structural schema. This establishes only schema compatibility, not deployed shape, values, authorization or business outcome.
Effects and verification
- Reads overrides for this host, ordered by date and start minute.
- Confirm the date and full window, and retain the discovered id for a later authorized mutation.
Refusals and recovery
Selected source refusals are listed below; runtime middleware can return additional structured errors.
| HTTP | Error | Supported response |
|---|---|---|
| 403 | forbidden | Reconcile the declared permission, organization and verified resource grant with the legitimate access owner; do not switch context to bypass a refusal. |
| 404 | no_host | Read host.get; if it returns host:null, create the intended workspace host through host.update before retrying. |
Recovery: This read does not mutate Calendar records. Correct the selected context or request fields before another authorized read.
Related actions
app_topolo_calendar.availability.get: Read the current host’s complete weekly rules and date overrides.app_topolo_calendar.availability.overrides.create: Create an override, or update a discovered override by its ID.app_topolo_calendar.availability.overrides.delete: Remove one override and let the weekly schedule apply again.
Declared schemas and provenance
The hidden action guide carries these exact current declared schemas. They are not rewritten to make the illustrations pass.
Input schema:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}
Output schema:
{
"title": "List availability overrides response",
"description": "Collection response returned by availability.overrides.list. The service may return the collection directly or in an envelope.",
"oneOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "availability record",
"properties": {
"id": {
"type": "string",
"description": "Stable identifier when the availability exposes one."
}
},
"additionalProperties": true
}
},
{
"type": "object",
"properties": {
"data": {
"oneOf": [
{
"type": "array",
"items": {
"type": "object",
"title": "availability record",
"properties": {
"id": {
"type": "string",
"description": "Stable identifier when the availability exposes one."
}
},
"additionalProperties": true
}
},
{
"type": "object",
"additionalProperties": true
}
]
},
"items": {
"type": "array",
"items": {
"type": "object",
"title": "availability record",
"properties": {
"id": {
"type": "string",
"description": "Stable identifier when the availability exposes one."
}
},
"additionalProperties": true
}
},
"availability": {
"type": "array",
"items": {
"type": "object",
"title": "availability record",
"properties": {
"id": {
"type": "string",
"description": "Stable identifier when the availability exposes one."
}
},
"additionalProperties": true
}
},
"count": {
"type": "integer",
"minimum": 0
},
"nextCursor": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
],
"x-topolo-contract-source": "derived-action-metadata",
"x-topolo-contract-precision": "structural"
}
Source: TopoloCalendar@b378ceb73800ee1d1e6c4ff6f0b4179918cf632c, apps/api/src/routes/admin-availability.ts. Current catalog metadata and source were compared without executing the application.
- Source-reviewed synthetic input/response; not captured or executed.
- Source revision is not proof of current deployment, caller access, provider connection or notification delivery.
- The illustrative response passes the declared structural schema. This establishes only schema compatibility, not deployed shape, values, authorization or business outcome.