DEdepot
CIService

ListWorkflows

Returns CI workflows for the authenticated organization, newest first. Filter by name, repository, status, trigger, commit SHA, or pull request number. Use pageSize to return up to 200 workflows.

post/depot.ci.v1.CIService/ListWorkflows

Request

  • Base URL
    https://api.depot.dev
  • Auth
    HTTP bearer

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

pageSizeinteger

Number of workflows to return per page. Maximum: 200. Default: 50.

namestring

Text to match against the workflow name or file path. Only workflows containing this text are returned.

repostring

Repository to return workflows from, in owner/name format. For example, "depot/cli".

statusstring[]

Statuses of workflows to return. Can be "queued", "running", "finished", "failed", or "cancelled". Multiple values are ORed.

triggerstring

Trigger event to return workflows for. For example, "push", "pull_request", "pull_request_target", "issue_comment", "merge_group", "schedule", "workflow_run", or "workflow_dispatch".

shastring

Commit SHA prefix to return workflows for, matched against the parent run's headSha. 1-40 hex characters.

prstring

Pull request number to return workflows for.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.