---
title: "GET /stages/prompt/prompts/"
method: GET
path: "/stages/prompt/prompts/"
tags: ["stages"]
---

# GET /stages/prompt/prompts/

`GET /stages/prompt/prompts/`

Prompt Viewset

## Query parameters

- `field_key` string
- `label` string
- `name` string
- `ordering` string
- `page` integer
- `page_size` integer
- `placeholder` string
- `search` string
- `type` 'text' | 'text_area' | 'text_read_only' | 'text_area_read_only' | 'username' | 'email' | 'password' | 'number' | 'checkbox' | 'radio-button-group' | 'dropdown' | 'date' | 'date-time' | 'file' | 'separator' | 'hidden' | 'static' | 'alert_info' | 'alert_warning' | 'alert_danger' | 'ak-locale'

## Response `200`

- PaginatedPromptList
  - `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` Prompt[], required
    - `pk` string, uuid, required
    - `name` string, required
    - `field_key` string, required — Name of the form field, also used to store the value
    - `label` string, required
    - `type` 'text' | 'text_area' | 'text_read_only' | 'text_area_read_only' | 'username' | 'email' | 'password' | 'number' | 'checkbox' | 'radio-button-group' | 'dropdown' | 'date' | 'date-time' | 'file' | 'separator' | 'hidden' | 'static' | 'alert_info' | 'alert_warning' | 'alert_danger' | 'ak-locale', required
    - `required` boolean
    - `placeholder` string — Optionally provide a short hint that describes the expected input value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple choices.
    - `initial_value` string — Optionally pre-fill the input with an initial value. When creating a fixed choice field, enable interpreting as expression and return a list to return multiple default choices.
    - `order` integer
    - `prompt_stages_obj` PromptStage[], required
      - `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'
      - `fields` string[], required
      - `validation_policies` string[]
    - `sub_text` string
    - `placeholder_expression` boolean
    - `initial_value_expression` boolean
  - `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)