Zum Inhalt
Für Agenten

cycle_get

Get Cycle

Markdown Tools als JSON

Beschreibung

Fetches a single cycle by prefix id (cyc_…). Returns the cycle's window, status, bucket (current / upcoming / past relative to today), the owning workspace, and progress stats — total tasks, completed count, completion ratio.

Zugriff

Zugriffsprofil: gated. Module: projects_tasks. Die Freigabe im Profil ersetzt keine Account-, Workspace- oder Rollenberechtigung.

Parameter

Name Typ Pflicht Beschreibung
account_id string Ja
id string Ja Cycle prefix ID (cyc_…).

Eingabeschema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "account_id": {
      "type": "string"
    },
    "id": {
      "type": "string",
      "description": "Cycle prefix ID (cyc_…)."
    }
  },
  "required": [
    "account_id",
    "id"
  ],
  "type": "object"
}

Ausgabeschema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "cycle": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "number": {
          "type": "integer"
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "status": {
          "type": "string",
          "enum": [
            "planned",
            "active",
            "completed",
            "cancelled"
          ]
        },
        "starts_on": {
          "type": "string",
          "format": "date"
        },
        "ends_on": {
          "type": "string",
          "format": "date"
        },
        "bucket": {
          "type": "string",
          "enum": [
            "current",
            "upcoming",
            "past"
          ]
        },
        "workspace": {
          "type": "object"
        },
        "progress": {
          "type": "object",
          "properties": {
            "total_tasks": {
              "type": "integer"
            },
            "completed_tasks": {
              "type": "integer"
            },
            "completion_ratio": {
              "type": "number",
              "description": "0.0 to 1.0; 0.0 when there are no tasks yet."
            }
          }
        }
      },
      "required": [
        "id",
        "number",
        "status",
        "starts_on",
        "ends_on",
        "bucket",
        "workspace",
        "progress"
      ]
    }
  },
  "required": [
    "cycle"
  ],
  "type": "object"
}
Seiten