List schedules

veryfront__list_schedules

Requires project.runs.read.

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

Call type: Read-only.

Arguments

FieldTypeRequiredDescription and constraints
project_referencestringNoProject ID or slug.
statusstringNoOnly schedules with this status. Values: "active", "paused", "deleting".
source_trigger_idstringNoOnly the schedule activated from this source schedule. Minimum length: 1. Maximum length: 255.
sort_bystringNoSort key: created_at (the default) or name. Values: "created_at", "name".
sort_orderstringNoSort direction: desc (the default) or asc. Values: "asc", "desc".
limitintegerNoMaximum schedules per page, 1 to 200; defaults to 100. Default: 100. Minimum: 1. Maximum: 200.
cursorstringNoThe page_info.next of the previous page: the id of its last schedule. Keep the filters and the sort the same across pages. Format: uuid.

Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__list_schedules",
    "arguments": {}
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

FieldTypeRequiredDescription and constraints
dataobject[]YesSchedules returned for the project.
page_infoobjectYesCursors of data; next is null on the last page.

Full schemas

json
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug."
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "paused",
        "deleting"
      ],
      "description": "Only schedules with this status."
    },
    "source_trigger_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Only the schedule activated from this source schedule."
    },
    "sort_by": {
      "type": "string",
      "enum": [
        "created_at",
        "name"
      ],
      "description": "Sort key: created_at (the default) or name."
    },
    "sort_order": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ],
      "description": "Sort direction: desc (the default) or asc."
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 200,
      "description": "Maximum schedules per page, 1 to 200; defaults to 100.",
      "default": 100
    },
    "cursor": {
      "type": "string",
      "format": "uuid",
      "description": "The page_info.next of the previous page: the id of its last schedule. Keep the filters and the sort the same across pages."
    }
  },
  "additionalProperties": false,
  "description": "Arguments for listing project schedules.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Schedule ID."
          },
          "project_id": {
            "type": "string",
            "format": "uuid",
            "description": "Owning project ID."
          },
          "name": {
            "type": "string",
            "description": "Human-readable schedule name."
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "paused",
              "deleting"
            ],
            "description": "Schedule status."
          },
          "paused_reason": {
            "type": [
              "string",
              "null"
            ],
            "description": "System pause reason when Veryfront pauses the schedule."
          },
          "paused_at": {
            "type": [
              "string",
              "null"
            ],
            "description": "Timestamp when Veryfront paused the schedule."
          },
          "last_failure_at": {
            "type": [
              "string",
              "null"
            ],
            "description": "Timestamp of the most recent schedule failure."
          },
          "last_failure_code": {
            "type": [
              "string",
              "null"
            ],
            "description": "Most recent schedule failure code."
          },
          "last_failure_message": {
            "type": [
              "string",
              "null"
            ],
            "description": "Most recent schedule failure message."
          },
          "last_failure_run_id": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid",
                "description": "The last failure run id associated with this record."
              },
              {
                "type": "null",
                "description": "The last failure run id returned by the tool."
              }
            ],
            "description": "Canonical run ID for the most recent schedule failure."
          },
          "target": {
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "task",
                  "workflow",
                  "agent"
                ],
                "description": "Kind of scheduled target."
              },
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 255,
                "description": "Target identifier. For agent schedules, this is the agent ID."
              },
              "conversation_mode": {
                "type": "string",
                "enum": [
                  "create_new",
                  "existing",
                  "none"
                ],
                "description": "Conversation behaviour for an agent target. Defaults to none. Use create_new for an agent that delegates with invoke_agent - a run with no conversation cannot be paused for delegation. Agent targets run headlessly by default; create_new or existing creates or appends a conversation message."
              },
              "conversation_id": {
                "anyOf": [
                  {
                    "type": "string",
                    "format": "uuid",
                    "description": "Conversation identifier associated with the record."
                  },
                  {
                    "type": "null",
                    "description": "Conversation identifier associated with this result."
                  }
                ],
                "description": "Existing conversation to continue. Only allowed when conversation_mode is existing, and required in that case."
              }
            },
            "required": [
              "kind",
              "id"
            ],
            "additionalProperties": false,
            "description": "Typed schedule target."
          },
          "schedule": {
            "type": "string",
            "description": "Schedule expression."
          },
          "timezone": {
            "type": "string",
            "description": "IANA timezone."
          },
          "runtime_target_kind": {
            "type": "string",
            "enum": [
              "main_branch",
              "environment",
              "preview_branch"
            ],
            "description": "Runtime target kind."
          },
          "runtime_target_environment_id": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid",
                "description": "The runtime target environment id associated with this record."
              },
              {
                "type": "null",
                "description": "The runtime target environment id returned by the tool."
              }
            ],
            "description": "Environment ID for environment schedules."
          },
          "runtime_target_branch_id": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid",
                "description": "The runtime target branch id associated with this record."
              },
              {
                "type": "null",
                "description": "The runtime target branch id returned by the tool."
              }
            ],
            "description": "Branch ID for preview branch schedules."
          },
          "config": {
            "type": "object",
            "additionalProperties": {
              "description": "Additional structured values associated with this result."
            },
            "description": "Run configuration without internal schedule target metadata."
          },
          "timeout_seconds": {
            "type": "integer",
            "description": "Per-run timeout in seconds."
          },
          "backoff_limit": {
            "type": "integer",
            "description": "Retry backoff limit."
          },
          "concurrency_policy": {
            "type": "string",
            "description": "How overlapping scheduled runs are handled."
          },
          "definition_source": {
            "type": "string",
            "enum": [
              "manual",
              "source"
            ],
            "description": "Whether the schedule is manually managed or source-defined."
          },
          "source_trigger_id": {
            "type": [
              "string",
              "null"
            ],
            "description": "Source trigger ID for source-defined schedules."
          },
          "source_path": {
            "type": [
              "string",
              "null"
            ],
            "description": "Source file path for source-defined schedules."
          },
          "source_hash": {
            "type": [
              "string",
              "null"
            ],
            "description": "Source definition hash for source-defined schedules."
          },
          "last_scheduled_at": {
            "type": [
              "string",
              "null"
            ],
            "description": "Last scheduled fire time."
          },
          "last_successful_at": {
            "type": [
              "string",
              "null"
            ],
            "description": "Last successful run time."
          },
          "health": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "maxStalenessSeconds": {
                    "type": "integer",
                    "exclusiveMinimum": 0,
                    "maximum": 9007199254740991,
                    "description": "The max staleness seconds associated with this record."
                  }
                },
                "required": [
                  "maxStalenessSeconds"
                ],
                "additionalProperties": false,
                "description": "Structured health details associated with this record."
              },
              {
                "type": "null",
                "description": "The health returned by the tool."
              }
            ],
            "description": "Optional staleness budget used for schedule health alerting."
          },
          "max_runs": {
            "anyOf": [
              {
                "type": "integer",
                "exclusiveMinimum": 0,
                "description": "The max runs associated with this record."
              },
              {
                "type": "null",
                "description": "The max runs returned by the tool."
              }
            ],
            "description": "Optional maximum run count."
          },
          "run_count": {
            "type": "integer",
            "minimum": 0,
            "description": "Fire reservations counted toward the repetition limit; released reservations are subtracted."
          },
          "completed_at": {
            "type": [
              "string",
              "null"
            ],
            "description": "Completion time for finite schedules."
          },
          "created_by": {
            "anyOf": [
              {
                "type": "string",
                "format": "uuid",
                "description": "The created by associated with this record."
              },
              {
                "type": "null",
                "description": "The created by returned by the tool."
              }
            ],
            "description": "User that created the schedule."
          },
          "integration_requirements": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "integration": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 255,
                  "pattern": "^[a-z0-9][a-z0-9_-]*$",
                  "description": "The integration associated with this record."
                },
                "required_scopes": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 255,
                    "description": "One required scope item associated with this record."
                  },
                  "maxItems": 50,
                  "description": "The required scopes associated with this record.",
                  "default": []
                },
                "resources": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "kind": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 64,
                        "pattern": "^[a-z][a-z0-9_-]*$",
                        "description": "The kind associated with this record."
                      },
                      "id": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 512,
                        "description": "Unique identifier for the record."
                      },
                      "parent": {
                        "type": "object",
                        "properties": {
                          "kind": {
                            "$ref": "#/properties/data/items/properties/integration_requirements/items/properties/resources/items/properties/kind",
                            "description": "The kind returned by the tool."
                          },
                          "id": {
                            "$ref": "#/properties/data/items/properties/integration_requirements/items/properties/resources/items/properties/id",
                            "description": "Unique identifier for the returned record."
                          }
                        },
                        "required": [
                          "kind",
                          "id"
                        ],
                        "additionalProperties": false,
                        "description": "The parent associated with this record."
                      }
                    },
                    "required": [
                      "kind",
                      "id"
                    ],
                    "additionalProperties": false,
                    "description": "One resource item associated with this record."
                  },
                  "maxItems": 50,
                  "description": "The resources associated with this record.",
                  "default": []
                }
              },
              "required": [
                "integration"
              ],
              "additionalProperties": false,
              "description": "One integration requirement item associated with this record."
            },
            "maxItems": 20,
            "description": "OAuth scopes and exact provider resources required before the schedule can run.",
            "default": []
          },
          "created_at": {
            "type": "string",
            "description": "Creation timestamp."
          },
          "updated_at": {
            "type": "string",
            "description": "Last update timestamp."
          }
        },
        "required": [
          "id",
          "project_id",
          "name",
          "status",
          "paused_reason",
          "paused_at",
          "last_failure_at",
          "last_failure_code",
          "last_failure_message",
          "last_failure_run_id",
          "target",
          "schedule",
          "timezone",
          "runtime_target_kind",
          "runtime_target_environment_id",
          "runtime_target_branch_id",
          "config",
          "timeout_seconds",
          "backoff_limit",
          "concurrency_policy",
          "definition_source",
          "source_trigger_id",
          "source_path",
          "source_hash",
          "last_scheduled_at",
          "last_successful_at",
          "health",
          "max_runs",
          "run_count",
          "completed_at",
          "created_by",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false,
        "description": "Recurring project schedule."
      },
      "description": "Schedules returned for the project."
    },
    "page_info": {
      "type": "object",
      "properties": {
        "self": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor that refers to the current page."
        },
        "first": {
          "type": "null",
          "description": "The first associated with this record."
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the next page."
        },
        "prev": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the previous page."
        }
      },
      "required": [
        "self",
        "first",
        "next",
        "prev"
      ],
      "additionalProperties": false,
      "description": "Cursors of data; next is null on the last page."
    }
  },
  "required": [
    "data",
    "page_info"
  ],
  "additionalProperties": false,
  "description": "List of project schedules.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}