Get a workspace ruleset

Get one of a workspace's own rulesets by id (rs_…), with its conditions, bypass actors and rules.

GET/workspaces/{workspace}/rulesets/{id}

Members only.

Authentication: Required. Send an access token as Authorization: Bearer.
MCP tool: workspace with action get_ruleset, and the same inputs
Scope: An access token needs workspace:read.

Path parameters

Name	Type	Required	Description
`workspace`	string	Yes	The workspace’s slug, e.g. “flagon-io”.
`id`	string	Yes	The ruleset’s id: rs_…

Example request

curl https://api.g1t.sh/workspaces/flagon-io/rulesets/rs_01kq3b2c3d4e5f6g7h8j9k0m1n \
  -H "Authorization: Bearer $G1T_TOKEN"

Example response

A successful request answers 200 with:

{
  "id": "rs_01kq3b2c3d4e5f6g7h8j9k0m1n",
  "level": "workspace",
  "workspace": "flagon-io",
  "name": "Release freeze",
  "enforcement": "evaluate",
  "target": "branch",
  "conditions": {
    "ref_name": {
      "include": [
        "~DEFAULT_BRANCH",
        "release/**"
      ],
      "exclude": []
    },
    "repository": {
      "include": [
        "~ALL"
      ],
      "exclude": [
        "sandbox-*"
      ],
      "visibility": "any",
      "topics": []
    }
  },
  "bypass_actors": [
    {
      "kind": "team",
      "value": "flagon-io/release",
      "mode": "always"
    }
  ],
  "rules": [
    {
      "type": "merge_window",
      "parameters": {
        "time_zone": "-05:00",
        "windows": [
          {
            "days": [
              "mon",
              "tue",
              "wed",
              "thu"
            ],
            "start": "09:00",
            "end": "17:00"
          }
        ],
        "freezes": [
          {
            "start": "2026-12-20T00:00:00Z",
            "end": "2027-01-04T00:00:00Z",
            "reason": "Holidays"
          }
        ],
        "exceptions": []
      },
      "applies_to": "everyone"
    },
    {
      "type": "cost_cap",
      "parameters": {
        "max_usd": 25
      },
      "applies_to": "agents"
    }
  ],
  "created_by": "syntaqx",
  "created_at": "2026-10-07T14:02:11.318Z",
  "updated_by": "syntaqx",
  "updated_at": "2026-10-07T14:02:11.318Z"
}

Errors

A failed request answers with one of these statuses and a body like {"error": {"code": "not_found", "message": "Repository not found."}}. See errors.

Status	Code	When
401	`unauthenticated`	A token is required, or the one sent is not valid.
403	`forbidden`	The token is valid but not allowed to do this, such as a member-only change or an agent token outside its repository.
404	`not_found`	It does not exist, or you cannot see it.
422	`invalid`	The input is not valid. `message` says which field and why.