---
title: "GET /flows/inspector/{flow_slug}/"
method: GET
path: "/flows/inspector/{flow_slug}/"
tags: ["flows"]
---

# GET /flows/inspector/{flow_slug}/

`GET /flows/inspector/{flow_slug}/`

Get current flow state and record it

## Path parameters

- `flow_slug` string, required

## Response `200`

- FlowInspection — Serializer for inspect endpoint
  - `plans` FlowInspectorPlan[], required
    - `current_stage` FlowStageBinding, required — FlowStageBinding Serializer
      - `pk` string, uuid, required
      - `policybindingmodel_ptr_id` string, uuid, required
      - `target` string, uuid, required
      - `stage` string, uuid, required
      - `stage_obj` Stage, required — Stage Serializer
        - `pk` string, uuid, required
        - `name` string, required
        - `component` string, required — Get object type so that we know how to edit the object
        - `verbose_name` string, required — Return object's verbose_name
        - `verbose_name_plural` string, required — Return object's plural verbose_name
        - `meta_model_name` string, required — Return internal model name
        - `flow_set` FlowSet[], required
          - `pk` string, uuid, required
          - `policybindingmodel_ptr_id` string, uuid, required
          - `name` string, required
          - `slug` string, required — Visible in the URL.
          - `title` string, required — Shown as the Title in Flow pages.
          - `designation` 'authentication' | 'authorization' | 'invalidation' | 'enrollment' | 'unenrollment' | 'recovery' | 'stage_configuration', required
          - `background_url` string, required — Get the URL to the background image
          - `policy_engine_mode` 'all' | 'any'
          - `compatibility_mode` boolean — Enable compatibility mode, increases compatibility with password managers on mobile devices.
          - `export_url` string, required — Get export URL for flow
          - `layout` 'stacked' | 'content_left' | 'content_right' | 'sidebar_left' | 'sidebar_right' | 'sidebar_left_frame_background' | 'sidebar_right_frame_background'
          - `denied_action` 'message_continue' | 'message' | 'continue'
      - `evaluate_on_plan` boolean — Evaluate policies during the Flow planning process.
      - `re_evaluate_policies` boolean — Evaluate policies when the Stage is presented to the user.
      - `order` integer, required
      - `policy_engine_mode` 'all' | 'any'
      - `invalid_response_action` 'retry' | 'restart' | 'restart_with_context'
    - `next_planned_stage` FlowStageBinding, required — FlowStageBinding Serializer
      - `pk` string, uuid, required
      - `policybindingmodel_ptr_id` string, uuid, required
      - `target` string, uuid, required
      - `stage` string, uuid, required
      - `stage_obj` Stage, required — Stage Serializer
        - `pk` string, uuid, required
        - `name` string, required
        - `component` string, required — Get object type so that we know how to edit the object
        - `verbose_name` string, required — Return object's verbose_name
        - `verbose_name_plural` string, required — Return object's plural verbose_name
        - `meta_model_name` string, required — Return internal model name
        - `flow_set` FlowSet[], required
          - `pk` string, uuid, required
          - `policybindingmodel_ptr_id` string, uuid, required
          - `name` string, required
          - `slug` string, required — Visible in the URL.
          - `title` string, required — Shown as the Title in Flow pages.
          - `designation` 'authentication' | 'authorization' | 'invalidation' | 'enrollment' | 'unenrollment' | 'recovery' | 'stage_configuration', required
          - `background_url` string, required — Get the URL to the background image
          - `policy_engine_mode` 'all' | 'any'
          - `compatibility_mode` boolean — Enable compatibility mode, increases compatibility with password managers on mobile devices.
          - `export_url` string, required — Get export URL for flow
          - `layout` 'stacked' | 'content_left' | 'content_right' | 'sidebar_left' | 'sidebar_right' | 'sidebar_left_frame_background' | 'sidebar_right_frame_background'
          - `denied_action` 'message_continue' | 'message' | 'continue'
      - `evaluate_on_plan` boolean — Evaluate policies during the Flow planning process.
      - `re_evaluate_policies` boolean — Evaluate policies when the Stage is presented to the user.
      - `order` integer, required
      - `policy_engine_mode` 'all' | 'any'
      - `invalid_response_action` 'retry' | 'restart' | 'restart_with_context'
    - `plan_context` object, required — Get the plan's context, sanitized
    - `session_id` string, required — Get a unique session ID
  - `current_plan` FlowInspectorPlan — Serializer for an active FlowPlan
    - `current_stage` FlowStageBinding, required — FlowStageBinding Serializer
      - `pk` string, uuid, required
      - `policybindingmodel_ptr_id` string, uuid, required
      - `target` string, uuid, required
      - `stage` string, uuid, required
      - `stage_obj` Stage, required — Stage Serializer
        - `pk` string, uuid, required
        - `name` string, required
        - `component` string, required — Get object type so that we know how to edit the object
        - `verbose_name` string, required — Return object's verbose_name
        - `verbose_name_plural` string, required — Return object's plural verbose_name
        - `meta_model_name` string, required — Return internal model name
        - `flow_set` FlowSet[], required
          - `pk` string, uuid, required
          - `policybindingmodel_ptr_id` string, uuid, required
          - `name` string, required
          - `slug` string, required — Visible in the URL.
          - `title` string, required — Shown as the Title in Flow pages.
          - `designation` 'authentication' | 'authorization' | 'invalidation' | 'enrollment' | 'unenrollment' | 'recovery' | 'stage_configuration', required
          - `background_url` string, required — Get the URL to the background image
          - `policy_engine_mode` 'all' | 'any'
          - `compatibility_mode` boolean — Enable compatibility mode, increases compatibility with password managers on mobile devices.
          - `export_url` string, required — Get export URL for flow
          - `layout` 'stacked' | 'content_left' | 'content_right' | 'sidebar_left' | 'sidebar_right' | 'sidebar_left_frame_background' | 'sidebar_right_frame_background'
          - `denied_action` 'message_continue' | 'message' | 'continue'
      - `evaluate_on_plan` boolean — Evaluate policies during the Flow planning process.
      - `re_evaluate_policies` boolean — Evaluate policies when the Stage is presented to the user.
      - `order` integer, required
      - `policy_engine_mode` 'all' | 'any'
      - `invalid_response_action` 'retry' | 'restart' | 'restart_with_context'
    - `next_planned_stage` FlowStageBinding, required — FlowStageBinding Serializer
      - `pk` string, uuid, required
      - `policybindingmodel_ptr_id` string, uuid, required
      - `target` string, uuid, required
      - `stage` string, uuid, required
      - `stage_obj` Stage, required — Stage Serializer
        - `pk` string, uuid, required
        - `name` string, required
        - `component` string, required — Get object type so that we know how to edit the object
        - `verbose_name` string, required — Return object's verbose_name
        - `verbose_name_plural` string, required — Return object's plural verbose_name
        - `meta_model_name` string, required — Return internal model name
        - `flow_set` FlowSet[], required
          - `pk` string, uuid, required
          - `policybindingmodel_ptr_id` string, uuid, required
          - `name` string, required
          - `slug` string, required — Visible in the URL.
          - `title` string, required — Shown as the Title in Flow pages.
          - `designation` 'authentication' | 'authorization' | 'invalidation' | 'enrollment' | 'unenrollment' | 'recovery' | 'stage_configuration', required
          - `background_url` string, required — Get the URL to the background image
          - `policy_engine_mode` 'all' | 'any'
          - `compatibility_mode` boolean — Enable compatibility mode, increases compatibility with password managers on mobile devices.
          - `export_url` string, required — Get export URL for flow
          - `layout` 'stacked' | 'content_left' | 'content_right' | 'sidebar_left' | 'sidebar_right' | 'sidebar_left_frame_background' | 'sidebar_right_frame_background'
          - `denied_action` 'message_continue' | 'message' | 'continue'
      - `evaluate_on_plan` boolean — Evaluate policies during the Flow planning process.
      - `re_evaluate_policies` boolean — Evaluate policies when the Stage is presented to the user.
      - `order` integer, required
      - `policy_engine_mode` 'all' | 'any'
      - `invalid_response_action` 'retry' | 'restart' | 'restart_with_context'
    - `plan_context` object, required — Get the plan's context, sanitized
    - `session_id` string, required — Get a unique session ID
  - `is_completed` boolean, required

## Other responses

- `400` — No flow plan in session.
- `403`

---

[API](https://skmtc.dev/goauthentik/apis/authentik.md) · [All operations](https://skmtc.dev/goauthentik/apis/authentik/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/goauthentik/authentik/revisions/4e42e86021d7/schema)