authentik/website/docs/developer-docs/api/reference/flows-instances-diagram-retrieve.api.mdx

---
id: flows-instances-diagram-retrieve
title: "flows_instances_diagram_retrieve"
description: "Return diagram for flow with slug `slug`, in the format used by flowchart.js"
sidebar_label: "flows_instances_diagram_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJytVclu2zAQ/RWCl7aAYAVODoVPDVo3MJC0QbZLEDiUNLYY06RCUk4NQf/eGWqxAts55ZKQ4izvvVlccVOAFV4aPcv4hC+UeXNzqZ0XOgU3z6RYWrGeW/BWwgZ4xDNwqZUFuaDDDfjSatbasYWxjGKwN+lz5lS5ZM/09zliUjOfA1mshWelg4wl22Cc5sL60YvD4IXAKODBOj55rLikFIXwOT5pfMAbRcObS3NYCz6puN8W4TsC1Ms9fA/SyURBl/3+5nLE64hbeC2lBaTsbQn1U8S9WFLORgGOHxykpZV+G4CIEr21lyu8PZG5BVcY7cARhPHJCf1LjfZoREdRFEqmQdf4xRGSah+ySV4g9XuQu9DMLBrFENEX10ss0mCHWlmqnZcNhvb5kCIWRPZXq21L9h39x96RNJBekedvzPir/VyT/XuAJODZp1J+EEpmwZVNrTV2j502er6QoLI50LsbhBTWii06SA9rt0+f4Kcmg8MvIsskpRXqepiv3mmxg9YgO6rH6SfqcQEarEzZ+fXsiCAZeCHVAVIfsX1X9ibAoOpt0g9o4iccztzQpliCD/OKsznhcZiauN8bcUVjWsdtb8U0sGA33ViXVpGTKGS8OY15PZi2W1KooTiYuZ5M7n3RTT/dExAWbEAm9cIEy5bOzj3ilLkhMT4Zn42+j8Z7kl+JFcrEOq+mcMzJdaFgxKNQWRw9yoAlJOl5DkqZH0vTZxpJQwXAsgPOb+jbZmldze4wREObKLhJHC9xQ5bJKDXreBAi3p0SZZIYU+n4cvZz+ud2GmgWxvm10IPgQXvWa98vimM7e9Cln72+2yp5+OfjQiF0kiPQrtpW6RYs1asFjOdJu9W7XRRxaswcqZJHVSXCwb1VdU2fX0uwtJXxuBFWioTK/Ugb0NEZm3MhlIMPWH+9aQfhGzsGulsumlbLRqiSbnhcwbb7Eaqf0C7H3YoNSPmbp/M0hcIPnPb2ALV7P0YXU+oMKvqgy9uujroDRT8ICJUJFndmBRrV6fB5uhPAuv4PZfG6Pw==
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_diagram_retrieve"}
>
</Heading>

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



Return diagram for flow with slug `slug`, in the format used by flowchart.js

<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":"slug","schema":{"type":"string","description":"Visible in the URL."},"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={"diagram"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","readOnly":true}}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"diagram\": \"string\"\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>