GET
GET /orgs/{org}/rulesets/rule-suites — GitHub API
GitHub token (required); https://api.github.com
GitHub APIList organization rule suites
- Base URL
- https://api.github.com
- Auth
- Authorization: Bearer <GITHUB_API_KEY>
- Last verified
- 2026-10-20 · upstream hash matched
Actions Try in browser→
Agents: curl -H "Accept: text/markdown" this URL
→ 372 tokens · Vary: Accept
→ 372 tokens · Vary: Accept
Critical gotchas
GitHub recommends an Accept: application/vnd.github+json header and an explicit X-GitHub-Api-Version header.
Fine-grained tokens only authorize repositories and permissions selected when the token is created.
cURL
curl -X GET 'https://api.github.com/orgs/example-org/rulesets/rule-suites?ref=example-ref&repository_name=example-repository-name&time_period=day&actor_name=example-actor-name&rule_suite_result=all&evaluate_status=all&per_page=30&page=1' \ -H "Authorization: Bearer $GITHUB_TOKEN" \ -H 'Accept: application/vnd.github+json' \ -H 'X-GitHub-Api-Version: 2026-03-10'
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org | path | string | Yes | The organization name. The name is not case sensitive. |
| ref | query | string | No | The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. |
| repository_name | query | string | No | The name of the repository to filter on. |
| time_period | query | string | No | The time period to filter by. For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). |
| actor_name | query | string | No | The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. |
| rule_suite_result | query | string | No | The rule suite results to filter on. When specified, only suites with this result will be returned. |
| evaluate_status | query | string | No | The evaluate status to filter on. When specified, only rule suites resulting from rulesets with the specified evaluate status will be returned. - `all` - all rule suites will be returned. - `active` - only rule suites resulting from rulesets in active (non-evaluate) mode will be returned. - `evaluate` - only rule suites resulting from rulesets in evaluate mode will be returned. |
| per_page | query | integer | No | The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." |
| page | query | integer | No | The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." |
Response 200 OK
[
{
"id": 0,
"actor_id": 0,
"actor_name": "string",
"before_sha": "string",
"after_sha": "string",
"ref": "string",
"repository_id": 0,
"repository_name": "string",
"pushed_at": "2011-01-26T19:06:43Z",
"result": "pass",
"evaluation_result": "pass"
}
] Get a free GitHub API key → sponsored Affiliate link - we may earn a commission, at no extra cost to you.