List check suites for a Git reference

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

Lists check suites for a commit ref. The ref can be a SHA, branch name, or a tag name. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

owner

string

必需

repo

string

必需

ref

string

必需

ref parameter

Query 参数

app_id

integer

可选

Filters check suites by GitHub App id.

示例值:

check_name

string

可选

Returns check runs with the specified name.

per_page

integer

可选

Results per page (max 100).

page

integer

可选

Page number of the results to fetch.

返回响应

🟢200Response

application/json

Body

check_suites

array[object (CheckSuite) {17}]

必需

after

string | null

必需

示例值:

d6fde92930d4715a2b49857d24b940956b26d2d3

app

null | allOf {1}

必需

before

string | null

必需

示例值:

146e867f55c26428e5f9fade55a9bbf5e95a7912

check_runs_url

string

必需

conclusion

enum<string> | enum<null>

必需

枚举值:

successfailureneutralcancelledskippedtimed_outaction_required

示例值:

neutral

created_at

string <date-time> | null

必需

head_branch

string | null

必需

示例值:

master

head_commit

object (Simple Commit)

必需

Simple Commit

head_sha

string

必需

The SHA of the head commit that is being checked.

示例值:

009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d

integer

必需

示例值:

latest_check_runs_count

integer

必需

node_id

string

必需

示例值:

MDEwOkNoZWNrU3VpdGU1

pull_requests

array[object (Pull Request Minimal) {5}] | null

必需

repository

object (Minimal Repository)

必需

Minimal Repository

status

enum<string> | enum<null>

必需

枚举值:

queuedin_progresscompleted

示例值:

completed

updated_at

string <date-time> | null

必需

url

string | null

必需

示例值:

https://api.github.com/repos/github/hello-world/check-suites/5

total_count

integer

必需