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

# List Prompts

`GET /prompts`

List the prompts of a project

## Query parameters

- `project_id` string — Required if using a company api key
- `topic_id` string
- `tag_id` string
- `is_archived` string — Filter by archived status. Omit (or `false`) to return only active prompts; `true` to return only archived prompts.
- `start_date` string, date — Only return prompts created on or after this date (UTC).
- `end_date` string, date — Only return prompts created on or before this date (UTC).
- `search` string — Free-text search over prompt text. Fuzzy and word-order-insensitive; results are ordered by relevance (best match first).
- `limit` number
- `offset` number

## Response `200`

Success

- object — Success
  - `data` object[], required
    - `id` string, required
    - `messages` object[], required
      - `content` string, required
    - `tags` object[], required
      - `id` string, required
    - `topic` object, nullable, required
      - `id` string, required
    - `user_location` object, required
      - `country` 'AE' | 'AL' | 'AM' | 'AR' | 'AT' | 'AU' | 'BA' | 'BE' | 'BG' | 'BH' | 'BO' | 'BR' | 'BS' | 'BY' | 'CA' | 'CH' | 'CL' | 'CN' | 'CO' | 'CR' | 'CY' | 'CZ' | 'DE' | 'DK' | 'DO' | 'EC' | 'EE' | 'EG' | 'ES' | 'FI' | 'FR' | 'GB' | 'GE' | 'GH' | 'GR' | 'GT' | 'HK' | 'HN' | 'HR' | 'HU' | 'ID' | 'IE' | 'IL' | 'IN' | 'IQ' | 'IS' | 'IT' | 'JO' | 'JP' | 'KR' | 'KW' | 'LB' | 'LI' | 'LT' | 'LU' | 'LV' | 'MA' | 'MD' | 'ME' | 'MK' | 'MT' | 'MX' | 'MY' | 'NG' | 'NI' | 'NL' | 'NO' | 'NZ' | 'OM' | 'PK' | 'PA' | 'PE' | 'PH' | 'PL' | 'PT' | 'PY' | 'PS' | 'QA' | 'RO' | 'RS' | 'SA' | 'SE' | 'SG' | 'SI' | 'SK' | 'SV' | 'TH' | 'TN' | 'TR' | 'TW' | 'UA' | 'US' | 'UY' | 'VE' | 'VN' | 'ZA' | 'AD' | 'AF' | 'AS' | 'AZ' | 'BB' | 'BQ' | 'CG' | 'CI' | 'CM' | 'CW' | 'DM' | 'DZ' | 'FO' | 'GF' | 'GP' | 'JM' | 'KG' | 'KH' | 'KI' | 'KZ' | 'LK' | 'LR' | 'LS' | 'MW' | 'NC' | 'PG' | 'TD' | 'TF' | 'UG' | 'VU' | 'ZW', required
    - `volume` number
    - `is_archived` boolean, required — Whether the prompt is archived (no longer tracked daily). Only active prompts are returned unless `is_archived=true` is passed.
    - `created_at` string, date — full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21
  - `total_count` number, required — Total number of matching prompts, ignoring pagination
  - `totalCount` number, required — Total number of matching prompts, ignoring pagination
  - `search_truncated` boolean — Only present when `search` is used. True when the project has more prompts than the search scan limit (20000); only the most recent 20000 prompts were searched, so matches may be missing and total_count may undercount.

---

[API](https://skmtc.net/peec/apis/peec-ai-customer-api.md) · [All operations](https://skmtc.net/peec/apis/peec-ai-customer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/peec/peec-ai-customer-api/versions/92840a1bffa7/schema)