ScheduleView

One canonical schedule projection. header is the stored authored value; state is the converged ownership/lifecycle reduction.

Type object

Shape

Field	Type	Description
workspacerequired	WorkspaceId
documentrequired	DocumentId	DocumentId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path.
name	ScheduleName or null	Defaultable for the earlier unreleased v5 response shape. A missing value is displayed with the objective-derived compatibility fallback.
headerrequired	ScheduleHeader
staterequired	ScheduleState
next_firing	ScheduleNextFiring or null
firingsrequired	array of ScheduleFiringView

Example

{
  "workspace": "00000000-0000-4000-8000-000000000000",
  "document": "00000000-0000-4000-8000-000000000000",
  "name": "string",
  "header": {
    "schedule": "00000000-0000-4000-8000-000000000000",
    "created_at_ms": 0,
    "initial_owner": "string",
    "definition": {
      "revision": 0,
      "effective_at_ms": 0,
      "template": {
        "requested_by": {
          "profile": "00000000-0000-4000-8000-000000000000",
          "kind": "person"
        },
        "objective": "string",
        "agent": {
          "kind": "built_in",
          "value": "string"
        },
        "requested_model": "string",
        "scope": {
          "kind": "none"
        },
        "grants": [],
        "context": []
      },
      "recurrence": {
        "cron": "string",
        "type": "floating"
      },
      "lifecycle": "active"
    }
  },
  "state": {
    "owner": "string",
    "state": "active"
  },
  "next_firing": {
    "at_ms": 0,
    "kind": "exact"
  },
  "firings": [
    {
      "occurrence_ms": 0,
      "revision": 0,
      "outcome": "fired",
      "run": "00000000-0000-4000-8000-000000000000",
      "busy_holder": "00000000-0000-4000-8000-000000000000",
      "at": 0
    }
  ]
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Generated from contract version 1. Last updated November 12, 2026.