---
id: events-transports-list
title: "events_transports_list"
description: "NotificationTransport Viewset"
sidebar_label: "events_transports_list"
hide_title: true
hide_table_of_contents: true
api: eJytV11P4zgU/StWnqsGMfOw4mnRCo2QgEULzD6MUOUkt42njp2xnQJb9b/vvbbTpE1aCrsvENf34/j43mN7negaDHdCq+siuUhgBcrZmTNc2Vob/JTCumSSFGBzI2oyRLM77cRc5N7vsbVl3wW8WCDrmhtegQNjk4sf60SQz68GzBvOKZzBYaULwJHNS6h4crFO3FtNv1tnhFrgDKimQu8Ep4XEsdQ5p/8vkJVaL7uvmZU8XybPm81kPJX/dziV94um2hQQ8xv41QgDyMqcSwuT3dC7fPxdirxkcwGyYE6zxgJ7KUGxNhxzJTADtpHOTk+EUvMFfBDGJSMnhsRlYNiLcKVQPjX+LBR3UEQQDLdpFIdQDhZgBkBmVvzzUTR3AYaetysnagy4xiiGReexngzCAjd5+WE+ghvDSqze5X2sdCyoYqZVPlo/mdYSuDrs3RZoY+TR5M+TxPGF9dXuGzDBXyzkjRHuzXcQb3AblRNLHD2TPVJaa2XBUrzzszP6l2skTjn65HUtY3+mPy2RsR7m19lPyH27GlIBJ0K0WCwieB23VfDqelah8pINmcFK6MaOTua6UeNuuGQDB+acdlzOqGrGo1rHjZsJVcDr6Dxt5aHZTb+wfoRl9RbRQu4A7sLZTd5PRVsrnKRc9x2vPp3viR4Wbgyn4hEOKjtG/Ska/IB6wyU2qxnu63JMZufaVBwJT5pGFL6/ePGnklh2zjTQoX+i6U1b2oMangRBx4lWt9/T60lUdmJoD1Obc3SJt5jninLEnLMVmEzbEVD7jP0VtMeCRD5RC8nbqyTj7Oma3fAM5ICBzWSnjY8yaETSM6+wCcniBNJVIyXPaM0xZac7Q7nZXxZhZeTAVI8vRt4ThpkYvPKqlvFIIkM6kTiLOBnKrcZhXnJHf5QCOR10xA7Tk/ZIxZJ6fme7MNJeqJ6+dG0w7BMoRuPd0H3Ex9xlgZj/+h91cDfid+yjInB5ZYweNpTSaubP/BnQ/Cm93J03iLIYaySc4UUhKC2X9/18m46iDlpAdpCPL/8jH99Aobjk7PL++gAhBTjq6DF1OLzafmnEAL1iiEmPLJNkAFyp6fq6iLdPV+IgDWdp2l1mUxJqMKv2XuobOkl5LdLVlzTZ9E7dByIlrKp39m7xl87V7ZHuexPvGfEcEWquvWVcQec+SShzwH1+dv51+tv0fMDyLV/69oxesZmtoA6e+oNIOZ77zQz6iWBASv37Qm8zTYUmznGnQQVhjBeS2+tHDBGWTUuwF2m6QAFssmmuq7QXIu2+MqmzFFOp9Ob6j6u7hyu/zFpbV3HVCx7oZh3dbOzt0CvHd58RkWyHp3FaS0RAq4oqHDZ5e2FC421eHFAJlYiQLNbrjFt4MnKzoZ/DHY22vxCWRLe7Si7hrXuZrLhsIDTSQdMog8dNDy7/o6+GUToCkN675ZNgPvx2OIImPl0+ieTUd8M7ANony6f52Hs7HEm3fZycUjP9J8Up9ruPiM7jmQZ42fPXBnwUYMHjxQVFiEo7uF7mOdSu5zWQf4qyVc9vV6QO1Pj9W0dQtkn7QdHbQ0699WJjm3mLR70Eha3W4nc0xkQo3v8CqrStcw==
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_transports_list"}
>
</Heading>

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



NotificationTransport 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"}
    >
      Query Parameters
    </h3>
  </summary><div>
    <ul>
      <ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"mode","schema":{"type":"string","enum":["email","local","webhook","webhook_slack"]}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"name","schema":{"type":"string"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"name":"ordering","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","schema":{"type":"integer"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"name":"page_size","required":false,"in":"query","description":"Number of results to return per page.","schema":{"type":"integer"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"name":"search","required":false,"in":"query","description":"A search term.","schema":{"type":"string"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"send_once","schema":{"type":"boolean"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"webhook_url","schema":{"type":"string"}}}
      >
        
      </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={true}
                        className={"schemaItem"}
                      >
                        <details
                          style={{}}
                          className={"openapi-markdown__details"}
                        >
                          <summary
                            style={{}}
                          >
                            <span
                              className={"openapi-schema__container"}
                            >
                              <strong
                                className={"openapi-schema__property"}
                              >
                                pagination
                              </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"}}
                          >
                            <SchemaItem
                              collapsible={false}
                              name={"next"}
                              required={true}
                              schemaName={"number"}
                              qualifierMessage={undefined}
                              schema={{"type":"number"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"previous"}
                              required={true}
                              schemaName={"number"}
                              qualifierMessage={undefined}
                              schema={{"type":"number"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"count"}
                              required={true}
                              schemaName={"number"}
                              qualifierMessage={undefined}
                              schema={{"type":"number"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"current"}
                              required={true}
                              schemaName={"number"}
                              qualifierMessage={undefined}
                              schema={{"type":"number"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"total_pages"}
                              required={true}
                              schemaName={"number"}
                              qualifierMessage={undefined}
                              schema={{"type":"number"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"start_index"}
                              required={true}
                              schemaName={"number"}
                              qualifierMessage={undefined}
                              schema={{"type":"number"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"end_index"}
                              required={true}
                              schemaName={"number"}
                              qualifierMessage={undefined}
                              schema={{"type":"number"}}
                            >
                              
                            </SchemaItem>
                          </div>
                        </details>
                      </SchemaItem><SchemaItem
                        collapsible={true}
                        className={"schemaItem"}
                      >
                        <details
                          style={{}}
                          className={"openapi-markdown__details"}
                        >
                          <summary
                            style={{}}
                          >
                            <span
                              className={"openapi-schema__container"}
                            >
                              <strong
                                className={"openapi-schema__property"}
                              >
                                results
                              </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={undefined}
                              schema={{"type":"string"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"mode"}
                              required={false}
                              schemaName={"NotificationTransportModeEnum (string)"}
                              qualifierMessage={"**Possible values:** [`local`, `webhook`, `webhook_slack`, `email`]"}
                              schema={{"enum":["local","webhook","webhook_slack","email"],"type":"string","title":"NotificationTransportModeEnum"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"mode_verbose"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","description":"Return selected mode with a UI Label","readOnly":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"webhook_url"}
                              required={false}
                              schemaName={"uri"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","format":"uri"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"webhook_mapping"}
                              required={false}
                              schemaName={"uuid"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","format":"uuid","nullable":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"send_once"}
                              required={false}
                              schemaName={"boolean"}
                              qualifierMessage={undefined}
                              schema={{"type":"boolean","description":"Only send notification once, for example when sending a webhook into a chat channel."}}
                            >
                              
                            </SchemaItem><li>
                              <div
                                style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
                              >
                                ]
                              </div>
                            </li>
                          </div>
                        </details>
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"pagination\": {\n    \"next\": 0,\n    \"previous\": 0,\n    \"count\": 0,\n    \"current\": 0,\n    \"total_pages\": 0,\n    \"start_index\": 0,\n    \"end_index\": 0\n  },\n  \"results\": [\n    {\n      \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n      \"name\": \"string\",\n      \"mode\": \"local\",\n      \"mode_verbose\": \"string\",\n      \"webhook_url\": \"string\",\n      \"webhook_mapping\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n      \"send_once\": true\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>