---
id: events-rules-retrieve
title: "events_rules_retrieve"
description: "NotificationRule Viewset"
sidebar_label: "events_rules_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJy1WG1v2zgM/iuCccDu0NTudR1w6KcWa1EEaLehXfal6wWKzcRaZcmT5GRZkP9+pGQnzmu7rveltWWKIh8+JMXMIl2C4U5o1c2i0wjGoJztm0oC/gVnBK5EnSgDmxpRkhxKfdBODEXqt92iKPsiYGLBoWDJDS/AgbHR6f0sEiRecpfjJ4Uf6G1Q9KtKZLhi0xwKHp3OIjct6ZvFA9UIvwy1KbjDFS85XzfgnPV63QsWxJnI0GgxnNKzy4VlbfsYGRijSgPfK2EAvXSmgvlDJ3J8RFbWTke4YiGtjHBTbzuvXE6KH/HtgeQN2FIrC5YsPj46on+pVg6F6JGXpawPTb5ZsnO26aEefIPUPY3oHRjBpfgJhkA1FCUnwsnl49OIkbE8+6jkNLiLzgonacOnQcEaUENE1nXhB2e4Ql+Ns63P3Bg+Rc3CQWFfELQ7kOg6m+QizdnyBGZzXcmMDYBVFjLmNFOExhRj6ZdMzLpDXFPAuAFmvRrIOv67aod6IqRkGp0mZah2ophQXmwRS9brxmSaxaCHSGPgpPw49CEHVRXECNKaEu8n3KjgHJcYAeLIutcNsHe1xkvSQXRZ9f49EsVoaWv/m/OZxAfpbUwxZOjXiks2+JTzMXizR0ZX5XPCryop+YAMC+FfNeYChgLhDKZ4nUwPPdY2ZNAKrMsAWcSQcZXV4DrtQyNh6BgUpZt2VlNvotUbh/uU37h0oI9ZsAr8/uy48hb+bykR1C+Soir6K/oEZvjIH7qqYF8CCdu3FRpIkLYEBlpL4GrDwZ5HnmdZ4L8PQQiLDz8h32izHkYss3XV+TUiLLb2t5u+CdLGfm/EM8pCA9u82dNE/Yl9OzhwhwaWJeKTEfNIIZKqIQSBRpRkBovDmCNJA5cRjICj3U+ZXSFecqR7EdV+7AJu1dzbutvE7O93RyzNsS2m1BUZWjSECRW1a3C00mGZGAmsg5RXZ0mcHCSHSd+Xsdg3VJIilf/ef/06ic8ODh8O/sAPBf9xDWqErfUUj9hJxm1Ue2PxTFtKPmW0Ka4ZixaKMWylawPDeRDZrCdWjBRWLypvgMXMBA6HMC3Kh6srHEdnvaKY9VSo50FeKOswAFSMMlx21NF5muoK+7O3UnLr+lKPhNrL/QyPOXSigG0JgA1ZyL3bg8TS60t6p/TEG4Bdhf743QmqxBgZMagcbCUybhQEFJef2hT0iYE5+mQSkuDy9nIfAt0hBgcFLV4+rFW1GygGlIPPyOsX+4BdDX7nntCo+L36cIsqWhXhlVtEb++NaSMZdwasFR8yeDMwO7bWTWm1etcUWILXLrTrTIjCDXbfWcve3Nlu8votFWO3ccsjl05e9W78BSOahQvFpTF6M7R4NewPBcisD/T9F7hI5qc629bD57s5vwRkaVqwbCceb18RjytQSPOUnX/q7gAkA7e1xO31ts2EWkGbQ+HQPW7iEg5+uaYxclTPgpQPURLmq8QPlcmsmf/mCU2AYMbNrFgZSdK8FMn4beL52sxjdwRN8K01lS28yJ0rm3HS9y3ALAk3D6GG2kvWfiy3dyI6OVh/fHR8Ev8TH29gfcMffQ+qdzUXYlGUYaikkGIroxPqthLlIKU+G+nFSbHQvnXhRIHNzhM2TMI33c+Ust5tcsGeJgneBPJqEKe6SFoqkuXTQOpBgkep5Lr7/vLD3aV3s9TWFVy1lAfQmQed7ZrkW5zcN9TXMDv44RK8NWDzndd2z+ogL4Zo5BGdiP9PW4M+MSlHE0lwNhtwCz0j53Na/l6BoXkbH8ccq7dvScgGvKDQM7JpyKVdn2Dahv/Z3LX+Yi/5XWCrc035UFQ8xlxW9IaPjzBt/4Qxf0DZHIsq3fLR6PD5PE2hdK2NG9lO3F4ky9Ul0YAi3L56BQp3mofWkLRqFMLpJT7rR1AIaWOjo3cycD7/D0ZsMTg=
sidebar_class_name: "get api-method"
info_path: docs/developer-docs/api/reference/authentik
custom_edit_url: null
hide_send_button: true
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"events_rules_retrieve"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/events/rules/{pbm_uuid}/"}
>
  
</MethodEndpoint>



NotificationRule Viewset

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<details
  style={{"marginBottom":"1rem"}}
  className={"openapi-markdown__details"}
  data-collapsed={false}
  open={true}
>
  <summary
    style={{}}
  >
    <h3
      className={"openapi-markdown__details-summary-header-params"}
    >
      Path Parameters
    </h3>
  </summary><div>
    <ul>
      <ParamsItem
        className={"paramsItem"}
        param={{"in":"path","name":"pbm_uuid","schema":{"type":"string","format":"uuid"},"description":"A UUID string identifying this Notification Rule.","required":true}}
      >
        
      </ParamsItem>
    </ul>
  </div>
</details><div>
  <div>
    <ApiTabs
      label={undefined}
      id={undefined}
    >
      <TabItem
        label={"200"}
        value={"200"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={false}
                        name={"pk"}
                        required={true}
                        schemaName={"uuid"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","format":"uuid","readOnly":true,"title":"Pbm uuid"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"name"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"transports"}
                        required={false}
                        schemaName={"uuid[]"}
                        qualifierMessage={undefined}
                        schema={{"type":"array","items":{"type":"string","format":"uuid"},"description":"Select which transports should be used to notify the user. If none are selected, the notification will only be shown in the authentik UI."}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"severity"}
                        required={false}
                        schemaName={"SeverityEnum (string)"}
                        qualifierMessage={"**Possible values:** [`notice`, `warning`, `alert`]"}
                        schema={{"enum":["notice","warning","alert"],"type":"string","title":"SeverityEnum"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"group"}
                        required={false}
                        schemaName={"uuid"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","format":"uuid","nullable":true,"description":"Define which group of users this notification should be sent and shown to. If left empty, Notification won't ben sent."}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={true}
                        className={"schemaItem"}
                      >
                        <details
                          style={{}}
                          className={"openapi-markdown__details"}
                        >
                          <summary
                            style={{}}
                          >
                            <span
                              className={"openapi-schema__container"}
                            >
                              <strong
                                className={"openapi-schema__property"}
                              >
                                group_obj
                              </strong><span
                                className={"openapi-schema__name"}
                              >
                                 object
                              </span><span
                                className={"openapi-schema__divider"}
                              >
                                
                              </span><span
                                className={"openapi-schema__required"}
                              >
                                required
                              </span>
                            </span>
                          </summary><div
                            style={{"marginLeft":"1rem"}}
                          >
                            <div
                              style={{"marginTop":".5rem","marginBottom":".5rem"}}
                            >
                              
                              
                              Group Serializer
                              
                              
                            </div><SchemaItem
                              collapsible={false}
                              name={"pk"}
                              required={true}
                              schemaName={"uuid"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","format":"uuid","readOnly":true,"title":"Group uuid"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"num_pk"}
                              required={true}
                              schemaName={"integer"}
                              qualifierMessage={undefined}
                              schema={{"type":"integer","readOnly":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"name"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"is_superuser"}
                              required={false}
                              schemaName={"boolean"}
                              qualifierMessage={undefined}
                              schema={{"type":"boolean","description":"Users added to this group will be superusers."}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"parent"}
                              required={false}
                              schemaName={"uuid"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","format":"uuid","nullable":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"parent_name"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","readOnly":true,"nullable":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"users"}
                              required={false}
                              schemaName={"integer[]"}
                              qualifierMessage={undefined}
                              schema={{"type":"array","items":{"type":"integer"}}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={true}
                              className={"schemaItem"}
                            >
                              <details
                                style={{}}
                                className={"openapi-markdown__details"}
                              >
                                <summary
                                  style={{}}
                                >
                                  <span
                                    className={"openapi-schema__container"}
                                  >
                                    <strong
                                      className={"openapi-schema__property"}
                                    >
                                      users_obj
                                    </strong><span
                                      className={"openapi-schema__name"}
                                    >
                                       object[]
                                    </span><span
                                      className={"openapi-schema__divider"}
                                    >
                                      
                                    </span><span
                                      className={"openapi-schema__nullable"}
                                    >
                                      nullable
                                    </span><span
                                      className={"openapi-schema__required"}
                                    >
                                      required
                                    </span>
                                  </span>
                                </summary><div
                                  style={{"marginLeft":"1rem"}}
                                >
                                  <li>
                                    <div
                                      style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
                                    >
                                      Array [
                                    </div>
                                  </li><SchemaItem
                                    collapsible={false}
                                    name={"pk"}
                                    required={true}
                                    schemaName={"ID (integer)"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"integer","readOnly":true,"title":"ID"}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"username"}
                                    required={true}
                                    schemaName={"string"}
                                    qualifierMessage={"**Possible values:** `<= 150 characters`, Value must match regular expression `^[\\w.@+-]+$`"}
                                    schema={{"type":"string","description":"Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.","pattern":"^[\\w.@+-]+$","maxLength":150}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"name"}
                                    required={true}
                                    schemaName={"string"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"string","description":"User's display name."}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"is_active"}
                                    required={false}
                                    schemaName={"Active (boolean)"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"boolean","title":"Active","description":"Designates whether this user should be treated as active. Unselect this instead of deleting accounts."}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"last_login"}
                                    required={false}
                                    schemaName={"date-time"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"string","format":"date-time","nullable":true}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"email"}
                                    required={false}
                                    schemaName={"email"}
                                    qualifierMessage={"**Possible values:** `<= 254 characters`"}
                                    schema={{"type":"string","format":"email","title":"Email address","maxLength":254}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"attributes"}
                                    required={false}
                                    schemaName={"object"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"object"}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"uid"}
                                    required={true}
                                    schemaName={"string"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"string","readOnly":true}}
                                  >
                                    
                                  </SchemaItem><li>
                                    <div
                                      style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
                                    >
                                      ]
                                    </div>
                                  </li>
                                </div>
                              </details>
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"attributes"}
                              required={false}
                              schemaName={"object"}
                              qualifierMessage={undefined}
                              schema={{"type":"object"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"roles"}
                              required={false}
                              schemaName={"uuid[]"}
                              qualifierMessage={undefined}
                              schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={true}
                              className={"schemaItem"}
                            >
                              <details
                                style={{}}
                                className={"openapi-markdown__details"}
                              >
                                <summary
                                  style={{}}
                                >
                                  <span
                                    className={"openapi-schema__container"}
                                  >
                                    <strong
                                      className={"openapi-schema__property"}
                                    >
                                      roles_obj
                                    </strong><span
                                      className={"openapi-schema__name"}
                                    >
                                       object[]
                                    </span><span
                                      className={"openapi-schema__divider"}
                                    >
                                      
                                    </span><span
                                      className={"openapi-schema__required"}
                                    >
                                      required
                                    </span>
                                  </span>
                                </summary><div
                                  style={{"marginLeft":"1rem"}}
                                >
                                  <li>
                                    <div
                                      style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
                                    >
                                      Array [
                                    </div>
                                  </li><SchemaItem
                                    collapsible={false}
                                    name={"pk"}
                                    required={true}
                                    schemaName={"uuid"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"string","format":"uuid","readOnly":true,"title":"Uuid"}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"name"}
                                    required={true}
                                    schemaName={"string"}
                                    qualifierMessage={"**Possible values:** `<= 150 characters`"}
                                    schema={{"type":"string","maxLength":150}}
                                  >
                                    
                                  </SchemaItem><li>
                                    <div
                                      style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
                                    >
                                      ]
                                    </div>
                                  </li>
                                </div>
                              </details>
                            </SchemaItem>
                          </div>
                        </details>
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"name\": \"string\",\n  \"transports\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n  ],\n  \"severity\": \"notice\",\n  \"group\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"group_obj\": {\n    \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"num_pk\": 0,\n    \"name\": \"string\",\n    \"is_superuser\": true,\n    \"parent\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"parent_name\": \"string\",\n    \"users\": [\n      0\n    ],\n    \"users_obj\": [\n      {\n        \"pk\": 0,\n        \"username\": \"string\",\n        \"name\": \"string\",\n        \"is_active\": true,\n        \"last_login\": \"2024-07-29T15:51:28.071Z\",\n        \"email\": \"user@example.com\",\n        \"attributes\": {},\n        \"uid\": \"string\"\n      }\n    ],\n    \"attributes\": {},\n    \"roles\": [\n      \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n    ],\n    \"roles_obj\": [\n      {\n        \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n        \"name\": \"string\"\n      }\n    ]\n  }\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem><TabItem
        label={"400"}
        value={"400"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={false}
                        name={"non_field_errors"}
                        required={false}
                        schemaName={"string[]"}
                        qualifierMessage={undefined}
                        schema={{"type":"array","items":{"type":"string"}}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"code"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        name={"property name*"}
                        required={false}
                        schemaName={"any"}
                        qualifierMessage={undefined}
                        schema={{"type":"object","description":"Validation Error","properties":{"non_field_errors":{"type":"array","items":{"type":"string"}},"code":{"type":"string"}},"additionalProperties":{},"title":"ValidationError"}}
                        collapsible={false}
                        discriminator={false}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"non_field_errors\": [\n    \"string\"\n  ],\n  \"code\": \"string\"\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem><TabItem
        label={"403"}
        value={"403"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={false}
                        name={"detail"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"code"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"detail\": \"string\",\n  \"code\": \"string\"\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem>
    </ApiTabs>
  </div>
</div>