---
title: "List Configuration Rules"
method: GET
path: "/v1/cookie-consent/configs/{configId}/rules"
tags: ["cmp"]
---

# List Configuration Rules

`GET /v1/cookie-consent/configs/{configId}/rules`

## Request

- Base URL: `https://api.osano.com`
- URL: `https://api.osano.com/v1/cookie-consent/configs/{configId}/rules`
- Auth: API key in header `x-osano-api-key`
- TypeScript: <https://skmtc.dev/osano/apis/osano-api-reference/docs/v1/cookie-consent/configs/:configId/rules/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a list of Rules for a Cookie Consent Configuration by configuration ID.

## Path parameters

- `configId` string, required

## Query parameters

- `type` 'cookie' | 'script' | 'iframe' | 'localStorage'
- `classification` 'ESSENTIAL' | 'ANALYTICS' | 'MARKETING' | 'PERSONALIZATION' | 'HIDDEN' | 'BLACKLISTED'
- `limit` integer
- `next` string

## Response `200`

Success

- object
  - `items` union[]
    - union
      - object
        - `classification` 'ANALYTICS' | 'BLACKLISTED' | 'ESSENTIAL' | 'HIDDEN' | 'MARKETING' | 'PERSONALIZATION'
        - `rule` string: The type of the rule.
        - `disclosure` boolean: Whether the rule should be disclosed. If omitted, this property will default to `false`.
        - `title` string, nullable: The title of the rule. This is used in the consent disclosure in place of the rule when defined.
        - `vendorName` string, nullable: The value of the rule.
        - `type` 'cookie' | 'script' | 'iframe'
        - `ruleId` integer
        - `configId` string, uuid
        - `vendorId` string
        - `created` string, date-time
        - `updated` string, date-time
      - object
        - `classification` 'ANALYTICS' | 'BLACKLISTED' | 'ESSENTIAL' | 'HIDDEN' | 'MARKETING' | 'PERSONALIZATION'
        - `rule` string: The type of the rule.
        - `disclosure` boolean: Whether the rule should be disclosed. If omitted, this property will default to `false`.
        - `title` string, nullable: The title of the rule. This is used in the consent disclosure in place of the rule when defined.
        - `vendorName` string, nullable: The value of the rule.
        - `description` string, nullable: A description of the cookie to be used in disclosures.
        - `expiry` string, nullable: The length of time that must elapse before the cookie expires.
        - `type` 'cookie' | 'script' | 'iframe'
        - `ruleId` integer
        - `configId` string, uuid
        - `vendorId` string
        - `created` string, date-time
        - `updated` string, date-time

## Other responses

- `400`: Bad Request
- `404`: Not Found

## Changes

- **2026-11-06** `ac31099cf83e`: 1 breaking, 1 info
  - added `subschema #1, subschema #2` to the `items/items/` response property `oneOf` list for the response status `200`
  - removed `subschema #1, subschema #2` from the `items/items/` response property `oneOf` list for the response status `200`
- **2026-05-12** `4fc37598750d`: 1 breaking, 1 warning, 2 info
  - added `subschema #1, subschema #2` to the `items/items/` response property `oneOf` list for the response status `200`
  - for the `query` request parameter `limit`, the min was set to `1.00`
  - added the new enum value `localStorage` to the `query` request parameter `type`
  - removed `subschema #1, subschema #2` from the `items/items/` response property `oneOf` list for the response status `200`
- **2025-10-11** `5ab36f60b5d0`: 1 breaking, 1 info
  - added `subschema #1, subschema #2` to the `items/items/` response property `oneOf` list for the response status `200`
  - removed `subschema #1, subschema #2` from the `items/items/` response property `oneOf` list for the response status `200`

[Operation history](https://skmtc.dev/osano/apis/osano-api-reference/changes/v1/cookie-consent/configs/:configId/rules/get.md)

---

[API](https://skmtc.dev/osano/apis/osano-api-reference.md) - [All operations](https://skmtc.dev/osano/apis/osano-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/osano/apis/osano-api-reference/revisions/ac31099cf83e?raw)