> ## Documentation Index
> Fetch the complete documentation index at: https://docs.peec.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List Prompts

> List the prompts of a project



## OpenAPI

````yaml https://api.peec.ai/customer/v1/openapi/json get /prompts
openapi: 3.0.3
info:
  title: Peec AI Customer API
  description: Development documentation
  version: 1.0.0
  contact:
    name: Peec AI Team
    email: support@peec.ai
servers:
  - url: https://api.peec.ai/customer/v1
security: []
paths:
  /prompts:
    get:
      tags:
        - Project
      summary: List Prompts
      description: List the prompts of a project
      operationId: getPrompts
      parameters:
        - name: project_id
          in: query
          required: false
          schema:
            description: Required if using a company api key
            example: or_f45b94ba-5e35-4982-93ed-285e72ee14eb
            type: string
        - name: topic_id
          in: query
          required: false
          schema:
            type: string
        - name: tag_id
          in: query
          required: false
          schema:
            type: string
        - name: is_archived
          in: query
          required: false
          schema:
            description: >-
              Filter by archived status. Omit (or `false`) to return only active
              prompts; `true` to return only archived prompts.
            type: string
        - name: limit
          in: query
          required: false
          schema:
            default: 1000
            type: number
            minimum: 1
            maximum: 10000
        - name: offset
          in: query
          required: false
          schema:
            default: 0
            type: number
            minimum: 0
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: pr_93f790de-5b7a-45ee-b782-61103c81f20d
                        messages:
                          type: array
                          items:
                            type: object
                            properties:
                              content:
                                type: string
                                example: Example Prompt
                            required:
                              - content
                        tags:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: tg_23abec5b-100a-4261-9ee7-1effe68f0149
                            required:
                              - id
                        topic:
                          nullable: true
                          type: object
                          properties:
                            id:
                              type: string
                              example: to_e6b8cdd3-a51b-4d94-a866-28dbe6b830a6
                          required:
                            - id
                        user_location:
                          type: object
                          properties:
                            country:
                              type: string
                              enum:
                                - 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:
                            - country
                        volume:
                          type: number
                        is_archived:
                          type: boolean
                          example: false
                          description: >-
                            Whether the prompt is archived (no longer tracked
                            daily). Only active prompts are returned unless
                            `is_archived=true` is passed.
                      required:
                        - id
                        - messages
                        - tags
                        - topic
                        - user_location
                        - is_archived
                  total_count:
                    type: number
                    example: 42
                    description: Total number of matching prompts, ignoring pagination
                  totalCount:
                    type: number
                    example: 42
                    description: Total number of matching prompts, ignoring pagination
                    deprecated: true
                required:
                  - data
                  - total_count
                  - totalCount
                description: Success
      security:
        - APIKeyHeader: []
        - APIKeyQuery: []
        - BearerAuth: []
components:
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key
    APIKeyQuery:
      type: apiKey
      in: query
      name: api_key
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````