> For the complete documentation index, see [llms.txt](https://docs.wproofreader.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.wproofreader.com/v6.11.0/api-reference/style-guide-api/actions/get-rules-getrules.md).

# Get rules (getrules)

List style guide rules.

### Request

See [HTTP API Overview](/v6.11.0/api-reference/overview.md).

#### Parameters

| Parameter | Type   | Required | Default       | Notes                                                                                                                                           |
| --------- | ------ | -------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `cmd`     | string | Yes      | `style_guide` | Command name.                                                                                                                                   |
| `action`  | string | Yes      | `getrules`    | Action name.                                                                                                                                    |
| `lang`    | string | No       |               | <p>Language scope to list rules for (example: <code>en\_US</code> or <code>en</code>).<br>By default returns all rules from every language.</p> |
| `rule`    | string | No       |               | One rule ID, or a comma-separated list of rule IDs. Filter is applied within the selected `lang`.                                               |

### Behavior

* Without `lang`: lists rules in `common`.
* Without `rule`: returns all rules for the selected `lang`, grouped by style guide.
* With `rule`: returns only the matching rule(s) for the selected `lang`.

### Response

Multiple rule objects are returned.

See [Response schema](/v6.11.0/api-reference/style-guide-api/response-schema.md).

### Errors

See [Errors](/v6.11.0/api-reference/style-guide-api/errors.md#getrules-errors).

### Examples

<details>

<summary>Example: get all rules</summary>

```json
{
  "cmd": "style_guide",
  "action": "getrules"
}
```

</details>

<details>

<summary>Example: get specific rules</summary>

```json
{
  "cmd": "style_guide",
  "action": "getrules",
  "lang": "en_US",
  "rule": "STYLE_111,STYLE_222"
}
```

</details>