list_workflow_runs
Retrieve and filter workflow runs for a GitHub repository by branch, status, event, or user, enabling efficient monitoring and management of CI/CD pipelines.
Instructions
List all workflow runs for a repository or a specific workflow
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| actor | No | Returns someone's workflow runs. Use the login for the user | |
| branch | No | Returns workflow runs associated with a branch | |
| checkSuiteId | No | Returns workflow runs with the check_suite_id | |
| created | No | Returns workflow runs created within date range (YYYY-MM-DD) | |
| event | No | Returns workflow runs triggered by the event | |
| excludePullRequests | No | If true, pull requests are omitted from the response | |
| owner | Yes | Repository owner (username or organization) | |
| page | No | Page number for pagination | |
| perPage | No | Results per page (max 100) | |
| repo | Yes | Repository name | |
| status | No | Returns workflow runs with the check run status | |
| workflowId | No | The ID of the workflow or filename |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"actor": {
"description": "Returns someone's workflow runs. Use the login for the user",
"type": "string"
},
"branch": {
"description": "Returns workflow runs associated with a branch",
"type": "string"
},
"checkSuiteId": {
"description": "Returns workflow runs with the check_suite_id",
"type": "number"
},
"created": {
"description": "Returns workflow runs created within date range (YYYY-MM-DD)",
"type": "string"
},
"event": {
"description": "Returns workflow runs triggered by the event",
"type": "string"
},
"excludePullRequests": {
"description": "If true, pull requests are omitted from the response",
"type": "boolean"
},
"owner": {
"description": "Repository owner (username or organization)",
"type": "string"
},
"page": {
"description": "Page number for pagination",
"type": "number"
},
"perPage": {
"description": "Results per page (max 100)",
"type": "number"
},
"repo": {
"description": "Repository name",
"type": "string"
},
"status": {
"description": "Returns workflow runs with the check run status",
"enum": [
"completed",
"action_required",
"cancelled",
"failure",
"neutral",
"skipped",
"stale",
"success",
"timed_out",
"in_progress",
"queued",
"requested",
"waiting",
"pending"
],
"type": "string"
},
"workflowId": {
"description": "The ID of the workflow or filename",
"type": [
"string",
"number"
]
}
},
"required": [
"owner",
"repo"
],
"type": "object"
}