Interface WorkflowRunsParams

Query parameters for listing workflow runs.

See

https://docs.github.com/en/rest/actions/workflow-runs#list-workflow-runs-for-a-repository

interface WorkflowRunsParams {
    actor?: string;
    branch?: string;
    created?: string;
    event?: string;
    page?: number;
    per_page?: number;
    status?: WorkflowRunStatus | WorkflowRunConclusion;
}

Hierarchy (View Summary)

Properties

actor? branch? created? event? page? per_page? status?

Properties

Optionalactor

actor?: string

Filter by actor (user login) who triggered the run

Optionalbranch

branch?: string

Filter by branch name

Optionalcreated

created?: string

Only return runs created after this ISO 8601 date

Optionalevent

event?: string

Filter by the triggering event (e.g., 'push', 'pull_request')

Optionalpage

page?: number

Page number to retrieve (1-based). Use nextPage from the previous response to paginate forward.

Optionalper_page

per_page?: number

Maximum number of results per page. GitHub default is 30, maximum is 100.

Optionalstatus

status?: WorkflowRunStatus | WorkflowRunConclusion

Filter by run status

Settings

Member Visibility

On This Page

Properties