---
title: "GET /flows/instances/"
method: GET
path: "/flows/instances/"
tags: ["flows"]
---

# GET /flows/instances/

`GET /flows/instances/`

Flow Viewset

## Query parameters

- `denied_action` 'message_continue' | 'message' | 'continue'
- `designation` 'authentication' | 'authorization' | 'invalidation' | 'enrollment' | 'unenrollment' | 'recovery' | 'stage_configuration'
- `flow_uuid` string, uuid
- `name` string
- `ordering` string
- `page` integer
- `page_size` integer
- `search` string
- `slug` string

## Response `200`

- PaginatedFlowList
  - `pagination` Pagination, required
    - `next` number, required
    - `previous` number, required
    - `count` number, required
    - `current` number, required
    - `total_pages` number, required
    - `start_index` number, required
    - `end_index` number, required
  - `results` Flow[], 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` string — Background shown during execution
    - `background_url` string, required — Get the URL to the background image
    - `background_themed_urls` ThemedUrls, required — Themed URLs - maps theme names to URLs for light and dark themes
      - `light` string, nullable
      - `dark` string, nullable
    - `stages` string[], required
    - `policies` string[], required
    - `cache_count` integer, required — Get count of cached flows
    - `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'
    - `authentication` 'none' | 'require_authenticated' | 'require_unauthenticated' | 'require_superuser' | 'require_redirect' | 'require_outpost' | 'require_token'
  - `autocomplete` Autocomplete, required

## Other responses

- `400`
- `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)