---
id: flows-instances-list
title: "flows_instances_list"
description: "Flow Viewset"
sidebar_label: "flows_instances_list"
hide_title: true
hide_table_of_contents: true
api: eJzNWN1v2zYQ/1cIYW9z7CDtgC1PC1q3CJC2QZN2wNpMoKWzzYYiVZJy4gT+33dHSjZly46d9qEviUUe7+PH++Rjoksw3AmtzvPkNBlLfWdToazjKgObSmFd0ktysJkRJZEh0RskYp8F3FmgzZIbXoADY5PTL4+JIJLvFZg57incwc8clIA85Znn0EtsNoWCJ6ePiZuXRGCdEWqCO6CqAtkkmVZOqApwqQBr+ST6lS43bxbrur3SaiwmlQF2N+WO2amuZM6mvCxB4RL+4YyMZF4ly3iGZlrmNK5XFkz/q/qqkkVvmx1WTBTf2wpeORTpRNYcoQVtxEPzDcpoKQukwQ+hZlyKvNkzkOlZEI/XEcz2tjUElYqOb0LxGjKBKwEINxWW+YvD/2hozsba9NkbbRjc86KU0EMaYGctjQNUeMJALlAfR0AFFBWr1FFkH3Ik/NhMWOEQ13rndjegxD+tKpHvhBNVLbjDFU+52MbM/9vOx5+rSbXJoWZu4HuFtqH3j7m00GuzbkP6z1RkUzYWgD6FSKDBAY2GnYfQgK2ks/09VSmDbx+ixhmjQwydbISI3wm8XOVF47JQ/i6CEgwjtFMPoRxMwGwoklrxcKg274MaetxYTtAYcJVRDJOL13VvJSxwk00PxiMcY5iEiidx73IdK6vJznM3vQRjkDJcyJEJLljIKiPc3Ke9pcPj1w2RIxilVhYssTs5PqZ/lLgoWPEnZiRZR9ngmyUzHjfF69E3DDrKsYbytBOBW33NIpzaTavg3kVUwWcwHpEMZkJXtnMz05XqPoYmG9iy57TjMqX77uaKacw4rC453Hfug8q37i5il/gSzIqMaFReKdhWpy08FkU3K5wkWZcrXL04782RLtwYTk4jHBS2C/qOOnmFiQGz+gPasHGNt08nO1KD5x+URC9zpoKVsp57SIjIWKMzzUdoETIpdA5otzMpbh4sYdEExUYQ9EKYdHBs2/0ZS8BIAquT0qePFxSTBb+/ADVx0+T0j2PqGhxGK5H/9+WIHz2cHf17fPRXevP7b96TgpFPSbqa6jusRdbLuaYzJNQj46+9n4SquCzaFHhSfhj7kN27Sq8V5lbRbhXhJ4s2OduaRfF9vl6pOiTlKI/8kkWdcB3x7HZiMOo6nayt9ltwjS+QNPq5Os5EQSWCnY/9BnkfqTdAAFELLK7Mx671lY5NnSu/KuGCBVRlUEtuj4TtcmV/CfvE8LZmo4OnDzbxs7lmHLN/up54mxrZBainpbrrj+YsFKZtCs9TjD6hIKX0QBKW7i8l+bya7/LOS89i6Dm8Iwa+SBQYxWIkJBbBJduaw0hrCVxtKD5UnHJD6yyjsz0M3QxVx4q5tuuvveTW3mGfxQqu8EqNZejJhUYSwF5+JrI62uG+1JjnKyP388pA7x0T78hj2AWh5HNduRg29KzsFnJfeXxVTyWMXfRpxGRK3xYDdsRNs918hu0nEsKFFxtyQW9tjOrMZRsjUjw/ream7VJfexln2Y4c9MMzFtmylnQ7jVFaRc1o2kpM0Xqltu3YCsstiYzWEM9S253It/PlFhQ+1t0IkzADSWHYNgmzac5alcQjELAIAPU32poop7YzQm9t9ozcvNcMPthPRMlpV1PQWza8ru6Oguk3be9D9db0izrPVYO02UFB7p2XHg88izZydP0vf7AhXus4luWZDY3Rm60WelLqx7YUaP+A1L3wiS7v6ofIi/NckFguL2N5qw4mUi1othWPFz8Rj7egsO3M2Nnl+RZAcnBcdKTIndbGnlAziO6+FrrDzAUlIwwIemma1G9H1A8mA1+6Bst3pwG5JphZ86bks3ky4KUYzF4MfDA2w9cVQRJsikawpfbULTSDnS9LOCjW44RQY+0pa/1Xx3sJSQ5anxyfvOz/2T/ZwPgdv6WJfy3oraC2q18nW8zUvmQUHutkClLqvyd61UcJTYjjPQNOit5Rwzz67vyaektvNplgTweDCZbBatTH2jiIWAxWv0ZSjwYoSg0uzl8N318NvZmU7LBmRsw92GwJNut65Itccf29r0bW4QQ2KCWKIxPqehvus5mRCeNaCP4mX5lS5sX9x8cRFvpPRi4WtBymcbrpXFjqD1Zj/1atfs5L3xZzbmHe8WyJU0AFIWAP0fQX6dn3sTcuMbutDSfi97t96OtK9UwgD31+22Fq9AD4TGUOfoTboU39BvhMTfZ9gHtCgebt79l4rD3C7RC3fOXbx2fqVmVFekMfRhCtf2zDtILtOmZ1SiDhzBkGe+miUxvVlLgsi9Hb4XU99scTTCgVveYHcW96BjWPeGMy8xTX+hYUJrRGcUffKAhr4f/uEtie
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={"flows_instances_list"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/flows/instances/"}
>
  
</MethodEndpoint>



Flow 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":"denied_action","schema":{"type":"string","enum":["continue","message","message_continue"]},"description":"Configure what should happen when a flow denies access to a user.\n\n"}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"designation","schema":{"type":"string","enum":["authentication","authorization","enrollment","invalidation","recovery","stage_configuration","unenrollment"]},"description":"Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.\n\n"}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"flow_uuid","schema":{"type":"string","format":"uuid"}}}
      >
        
      </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":"slug","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":"Flow uuid"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"policybindingmodel_ptr_id"}
                              required={true}
                              schemaName={"uuid"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","format":"uuid","readOnly":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"name"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"slug"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={"**Possible values:** `<= 50 characters`, Value must match regular expression `^[-a-zA-Z0-9_]+$`"}
                              schema={{"type":"string","description":"Visible in the URL.","maxLength":50,"pattern":"^[-a-zA-Z0-9_]+$"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"title"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","description":"Shown as the Title in Flow pages."}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"designation"}
                              required={true}
                              schemaName={"FlowDesignationEnum (string)"}
                              qualifierMessage={"**Possible values:** [`authentication`, `authorization`, `invalidation`, `enrollment`, `unenrollment`, `recovery`, `stage_configuration`]"}
                              schema={{"enum":["authentication","authorization","invalidation","enrollment","unenrollment","recovery","stage_configuration"],"type":"string","title":"FlowDesignationEnum"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"background"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","description":"Get the URL to the background image. If the name is /static or starts with http\nit is returned as-is","readOnly":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"stages"}
                              required={true}
                              schemaName={"uuid[]"}
                              qualifierMessage={undefined}
                              schema={{"type":"array","items":{"type":"string","format":"uuid"},"readOnly":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"policies"}
                              required={true}
                              schemaName={"uuid[]"}
                              qualifierMessage={undefined}
                              schema={{"type":"array","items":{"type":"string","format":"uuid"},"readOnly":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"cache_count"}
                              required={true}
                              schemaName={"integer"}
                              qualifierMessage={undefined}
                              schema={{"type":"integer","description":"Get count of cached flows","readOnly":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"policy_engine_mode"}
                              required={false}
                              schemaName={"PolicyEngineMode (string)"}
                              qualifierMessage={"**Possible values:** [`all`, `any`]"}
                              schema={{"enum":["all","any"],"type":"string","title":"PolicyEngineMode"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"compatibility_mode"}
                              required={false}
                              schemaName={"boolean"}
                              qualifierMessage={undefined}
                              schema={{"type":"boolean","description":"Enable compatibility mode, increases compatibility with password managers on mobile devices."}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"export_url"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","description":"Get export URL for flow","readOnly":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"layout"}
                              required={false}
                              schemaName={"FlowLayoutEnum (string)"}
                              qualifierMessage={"**Possible values:** [`stacked`, `content_left`, `content_right`, `sidebar_left`, `sidebar_right`]"}
                              schema={{"enum":["stacked","content_left","content_right","sidebar_left","sidebar_right"],"type":"string","title":"FlowLayoutEnum"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"denied_action"}
                              required={false}
                              schemaName={"DeniedActionEnum (string)"}
                              qualifierMessage={"**Possible values:** [`message_continue`, `message`, `continue`]"}
                              schema={{"enum":["message_continue","message","continue"],"type":"string","title":"DeniedActionEnum"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"authentication"}
                              required={false}
                              schemaName={"AuthenticationEnum (string)"}
                              qualifierMessage={"**Possible values:** [`none`, `require_authenticated`, `require_unauthenticated`, `require_superuser`, `require_outpost`]"}
                              schema={{"enum":["none","require_authenticated","require_unauthenticated","require_superuser","require_outpost"],"type":"string","title":"AuthenticationEnum"}}
                            >
                              
                            </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      \"policybindingmodel_ptr_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n      \"name\": \"string\",\n      \"slug\": \"string\",\n      \"title\": \"string\",\n      \"designation\": \"authentication\",\n      \"background\": \"string\",\n      \"stages\": [\n        \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n      ],\n      \"policies\": [\n        \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n      ],\n      \"cache_count\": 0,\n      \"policy_engine_mode\": \"all\",\n      \"compatibility_mode\": true,\n      \"export_url\": \"string\",\n      \"layout\": \"stacked\",\n      \"denied_action\": \"message_continue\",\n      \"authentication\": \"none\"\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>