> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Rules

Retrieve a list of rules with optional filtering.

<Note>
  External Documentation

  To learn more, visit the [Upwind documentation](https://docs.upwind.io/restapi/v1/get-custom-rules).
</Note>

## Basic Parameters

<div className="integrations-table">
  | Parameter        | Description                                       |
  | ---------------- | ------------------------------------------------- |
  | Framework ID     | The framework ID to filter results by.            |
  | Name             | The name of the rule to filter results by.        |
  | Organization ID  | The ID of the organization.                       |
  | Page             | The page number to get results from.              |
  | Per Page         | The maximum number of results to return per page. |
  | Return All Pages | Automatically fetch all resources, page by page.  |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter            | Description                                                                        |
  | -------------------- | ---------------------------------------------------------------------------------- |
  | Has Findings         | Select to include only rules that have findings.                                   |
  | Maximum Created Time | The date and time used to filter results that were created before this value.      |
  | Maximum Update Time  | The date and time used to filter results that were last updated before this value. |
  | Minimum Created Time | The date and time used to filter results that were created after this value.       |
  | Minimum Update Time  | The date and time used to filter results that were last updated after this value.  |
</div>

## Example Output

```json theme={"dark"}
[
	{
		"id": "string",
		"name": "string",
		"framework": "string",
		"findings_count": 0,
		"create_time": "2024-07-29T15:51:28.071Z",
		"update_time": "2024-07-29T15:51:28.071Z"
	}
]
```

## Workflow Library Example

[List Rules with Upwind and Send Results Via Email](https://library.blinkops.com/workflows/list-rules-with-upwind-and-send-results-via-email)

<div className="iframe-wrapper">
  <div className="iframe-media">
    <img src="https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max&auto=format&n=ojHYuDeYX5FWuN8a&q=85&s=b8af968e71438a9499c3223c9bd29fb2" alt="Workflow Library" width="16" height="16" data-path="img/Icons/play-box.svg" />

    Preview this Workflow on desktop
  </div>

  <iframe className="iframe" src="https://library.blinkops.com/workflows/list-rules-with-upwind-and-send-results-via-email/canvas" />
</div>