---
title: "Retrieve all push rulesets."
method: GET
path: "/_matrix/client/v3/pushrules/"
tags: ["Push notifications"]
---

# Retrieve all push rulesets.

`GET /_matrix/client/v3/pushrules/`

## Request

- Base URL: `https://matrix.org`
- URL: `https://matrix.org/_matrix/client/v3/pushrules/`
- Auth: one of:
  - API key in query parameter `access_token`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/matrix/apis/matrix-client-server-api/docs/_matrix/client/v3/pushrules/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve all push rulesets for this user. Currently the only push ruleset
defined is `global`.

## Response `200`

All the push rulesets for this user.

- object
  - `global` object, required: The global ruleset.
    - `content` object[]
      - `actions` union[], required: The actions to perform when this rule is matched.
        - union
          - string
          - object
      - `conditions` object[]: The conditions that must hold true for an event in order for a rule to be applied to an event. A rule with no conditions always matches. Only applicable to `underride` and `override` rules.
        - `is` string: Required for `room_member_count` conditions. A decimal integer optionally prefixed by one of, ==, <, >, >= or <=. A prefix of < matches rooms where the member count is strictly less than the given number and so forth. If no prefix is present, this parameter defaults to ==.
        - `key` string: Required for `event_match`, `event_property_is` and `event_property_contains` conditions. The dot-separated field of the event to match. Required for `sender_notification_permission` conditions. The field in the power level event the user needs a minimum power level for. Fields must be specified under the `notifications` property in the power level event's `content`.
        - `kind` string, required: The kind of condition to apply. See [conditions](https://spec.matrix.org/v1.19/client-server-api/#conditions-1) for more information on the allowed kinds and how they work.
        - `pattern` string: Required for `event_match` conditions. The [glob-style pattern](https://spec.matrix.org/v1.19/appendices#glob-style-matching) to match against.
        - `value` union: Required for `event_property_is` and `event_property_contains` conditions. A non-compound [canonical JSON](https://spec.matrix.org/v1.19/appendices#canonical-json) value to match against.
          - string
          - integer
          - boolean
      - `default` boolean, required: Whether this is a default rule, or has been set explicitly.
      - `enabled` boolean, required: Whether the push rule is enabled or not.
      - `pattern` string: The [glob-style pattern](https://spec.matrix.org/v1.19/appendices#glob-style-matching) to match against. Only applicable to `content` rules.
      - `rule_id` string, required: The ID of this rule.
    - `override` object[]
      - `actions` union[], required: The actions to perform when this rule is matched.
        - union
          - string
          - object
      - `conditions` object[]: The conditions that must hold true for an event in order for a rule to be applied to an event. A rule with no conditions always matches. Only applicable to `underride` and `override` rules.
        - `is` string: Required for `room_member_count` conditions. A decimal integer optionally prefixed by one of, ==, <, >, >= or <=. A prefix of < matches rooms where the member count is strictly less than the given number and so forth. If no prefix is present, this parameter defaults to ==.
        - `key` string: Required for `event_match`, `event_property_is` and `event_property_contains` conditions. The dot-separated field of the event to match. Required for `sender_notification_permission` conditions. The field in the power level event the user needs a minimum power level for. Fields must be specified under the `notifications` property in the power level event's `content`.
        - `kind` string, required: The kind of condition to apply. See [conditions](https://spec.matrix.org/v1.19/client-server-api/#conditions-1) for more information on the allowed kinds and how they work.
        - `pattern` string: Required for `event_match` conditions. The [glob-style pattern](https://spec.matrix.org/v1.19/appendices#glob-style-matching) to match against.
        - `value` union: Required for `event_property_is` and `event_property_contains` conditions. A non-compound [canonical JSON](https://spec.matrix.org/v1.19/appendices#canonical-json) value to match against.
          - string
          - integer
          - boolean
      - `default` boolean, required: Whether this is a default rule, or has been set explicitly.
      - `enabled` boolean, required: Whether the push rule is enabled or not.
      - `pattern` string: The [glob-style pattern](https://spec.matrix.org/v1.19/appendices#glob-style-matching) to match against. Only applicable to `content` rules.
      - `rule_id` string, required: The ID of this rule.
    - `room` object[]
      - `actions` union[], required: The actions to perform when this rule is matched.
        - union
          - string
          - object
      - `conditions` object[]: The conditions that must hold true for an event in order for a rule to be applied to an event. A rule with no conditions always matches. Only applicable to `underride` and `override` rules.
        - `is` string: Required for `room_member_count` conditions. A decimal integer optionally prefixed by one of, ==, <, >, >= or <=. A prefix of < matches rooms where the member count is strictly less than the given number and so forth. If no prefix is present, this parameter defaults to ==.
        - `key` string: Required for `event_match`, `event_property_is` and `event_property_contains` conditions. The dot-separated field of the event to match. Required for `sender_notification_permission` conditions. The field in the power level event the user needs a minimum power level for. Fields must be specified under the `notifications` property in the power level event's `content`.
        - `kind` string, required: The kind of condition to apply. See [conditions](https://spec.matrix.org/v1.19/client-server-api/#conditions-1) for more information on the allowed kinds and how they work.
        - `pattern` string: Required for `event_match` conditions. The [glob-style pattern](https://spec.matrix.org/v1.19/appendices#glob-style-matching) to match against.
        - `value` union: Required for `event_property_is` and `event_property_contains` conditions. A non-compound [canonical JSON](https://spec.matrix.org/v1.19/appendices#canonical-json) value to match against.
          - string
          - integer
          - boolean
      - `default` boolean, required: Whether this is a default rule, or has been set explicitly.
      - `enabled` boolean, required: Whether the push rule is enabled or not.
      - `pattern` string: The [glob-style pattern](https://spec.matrix.org/v1.19/appendices#glob-style-matching) to match against. Only applicable to `content` rules.
      - `rule_id` string, required: The ID of this rule.
    - `sender` object[]
      - `actions` union[], required: The actions to perform when this rule is matched.
        - union
          - string
          - object
      - `conditions` object[]: The conditions that must hold true for an event in order for a rule to be applied to an event. A rule with no conditions always matches. Only applicable to `underride` and `override` rules.
        - `is` string: Required for `room_member_count` conditions. A decimal integer optionally prefixed by one of, ==, <, >, >= or <=. A prefix of < matches rooms where the member count is strictly less than the given number and so forth. If no prefix is present, this parameter defaults to ==.
        - `key` string: Required for `event_match`, `event_property_is` and `event_property_contains` conditions. The dot-separated field of the event to match. Required for `sender_notification_permission` conditions. The field in the power level event the user needs a minimum power level for. Fields must be specified under the `notifications` property in the power level event's `content`.
        - `kind` string, required: The kind of condition to apply. See [conditions](https://spec.matrix.org/v1.19/client-server-api/#conditions-1) for more information on the allowed kinds and how they work.
        - `pattern` string: Required for `event_match` conditions. The [glob-style pattern](https://spec.matrix.org/v1.19/appendices#glob-style-matching) to match against.
        - `value` union: Required for `event_property_is` and `event_property_contains` conditions. A non-compound [canonical JSON](https://spec.matrix.org/v1.19/appendices#canonical-json) value to match against.
          - string
          - integer
          - boolean
      - `default` boolean, required: Whether this is a default rule, or has been set explicitly.
      - `enabled` boolean, required: Whether the push rule is enabled or not.
      - `pattern` string: The [glob-style pattern](https://spec.matrix.org/v1.19/appendices#glob-style-matching) to match against. Only applicable to `content` rules.
      - `rule_id` string, required: The ID of this rule.
    - `underride` object[]
      - `actions` union[], required: The actions to perform when this rule is matched.
        - union
          - string
          - object
      - `conditions` object[]: The conditions that must hold true for an event in order for a rule to be applied to an event. A rule with no conditions always matches. Only applicable to `underride` and `override` rules.
        - `is` string: Required for `room_member_count` conditions. A decimal integer optionally prefixed by one of, ==, <, >, >= or <=. A prefix of < matches rooms where the member count is strictly less than the given number and so forth. If no prefix is present, this parameter defaults to ==.
        - `key` string: Required for `event_match`, `event_property_is` and `event_property_contains` conditions. The dot-separated field of the event to match. Required for `sender_notification_permission` conditions. The field in the power level event the user needs a minimum power level for. Fields must be specified under the `notifications` property in the power level event's `content`.
        - `kind` string, required: The kind of condition to apply. See [conditions](https://spec.matrix.org/v1.19/client-server-api/#conditions-1) for more information on the allowed kinds and how they work.
        - `pattern` string: Required for `event_match` conditions. The [glob-style pattern](https://spec.matrix.org/v1.19/appendices#glob-style-matching) to match against.
        - `value` union: Required for `event_property_is` and `event_property_contains` conditions. A non-compound [canonical JSON](https://spec.matrix.org/v1.19/appendices#canonical-json) value to match against.
          - string
          - integer
          - boolean
      - `default` boolean, required: Whether this is a default rule, or has been set explicitly.
      - `enabled` boolean, required: Whether the push rule is enabled or not.
      - `pattern` string: The [glob-style pattern](https://spec.matrix.org/v1.19/appendices#glob-style-matching) to match against. Only applicable to `content` rules.
      - `rule_id` string, required: The ID of this rule.

---

[API](https://skmtc.dev/matrix/apis/matrix-client-server-api.md) - [All operations](https://skmtc.dev/matrix/apis/matrix-client-server-api/llms.txt) - [OpenAPI document](https://skmtc.dev/matrix/apis/matrix-client-server-api/revisions/c7fe4072c681?raw)