---
title: "List Prompts"
method: GET
path: "/v1/prompts/list"
tags: ["prompts"]
---

# List Prompts

`GET /v1/prompts/list`

## Query parameters

- `page` integer
- `size` integer
- `sort_column` string, nullable
- `sort_desc` boolean, nullable

## Response `200`

Successful Response

- PromptPage
  - `items` NormalizedPrompt[], required
    - `id` string, uuid, required
    - `user_id` string, uuid, required
    - `content` string
    - `collect_fields` CollectField[], nullable
      - `field_type` 'field_type_email', required
      - `label` string, required
      - `name` string, required
      - `description` string, nullable
    - `context_endpoint` string, nullable
    - `prompt_template` string, uuid, nullable
  - `page` integer, required
  - `size` integer, required
  - `has_more` boolean, required
  - `total` integer, required
  - `total_is_estimated` boolean, required

## Other responses

- `422` — Validation Error

## Changes

- **2024-08-14** `63991d99e2e1` — 3 breaking, 4 info
  - response property `items/items/collect_fields` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `items/items/context_endpoint` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `items/items/prompt_template` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - `query` request parameter `sort_column` list-of-types was widened by adding types `null`
  - …3 more
- **2024-04-19** `55ae0e0bb01f` — 2 info
  - added the required property `total` to the response with the `200` status
  - added the required property `total_is_estimated` to the response with the `200` status
- **2024-03-18** `8b2983fa7531` — 2 warning, 4 info
  - deleted the `query` request parameter `args`
  - deleted the `query` request parameter `kwargs`
  - added the new optional `query` request parameter `page`
  - added the new optional `query` request parameter `size`
  - …2 more
- **2024-03-18** `500a519452b0` — 2 breaking, 2 warning
  - added the new required `query` request parameter `args`
  - added the new required `query` request parameter `kwargs`
  - deleted the `query` request parameter `page`
  - deleted the `query` request parameter `size`
- …earlier changes not shown

[Full history](https://skmtc.dev/vocodedev/apis/vocode-hosted-api/changes/v1/prompts/list/get.md)

---

[API](https://skmtc.dev/vocodedev/apis/vocode-hosted-api.md) · [All operations](https://skmtc.dev/vocodedev/apis/vocode-hosted-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vocodedev/vocode-hosted-api/revisions/ffca17c004e2/schema)