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

# List the prompts

> index is the unbranded questions behind the headline figures; custom is the branded and comparison ones. Two separate lists, never blended.



## OpenAPI

````yaml /api-reference/openapi.json get /projects/{projectId}/prompts
openapi: 3.1.0
info:
  title: Citino API
  version: v1
  description: >-
    Read how AI engines answer your market's questions, and keep your prompts,
    competitors, segments and engines in step from code. Every number carries
    its band and sample size.
servers:
  - url: https://api.citino.ai/v1
security:
  - bearerAuth: []
tags:
  - name: Brand and competitors
  - name: Definitions
  - name: Engines
  - name: Projects
  - name: Alerts
  - name: Attribution
  - name: Claims
  - name: Crawlability
  - name: Crawler activity
  - name: Metrics
  - name: Experiments
  - name: Prompts
  - name: Objections
  - name: Monthly reports
  - name: Reports
  - name: Runs
  - name: Searches
  - name: Sources
  - name: Work items
  - name: Settings
paths:
  /projects/{projectId}/prompts:
    get:
      tags:
        - Prompts
      summary: List the prompts
      description: >-
        index is the unbranded questions behind the headline figures; custom is
        the branded and comparison ones. Two separate lists, never blended.
      operationId: getProjectsByProjectIdPrompts
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            type: string
        - name: cursor
          in: query
          required: false
          description: The previous page's next_cursor.
          schema:
            description: The previous page's next_cursor.
            type: string
            minLength: 1
            maxLength: 512
        - name: limit
          in: query
          required: false
          description: Rows per page.
          schema:
            description: Rows per page.
            type: integer
            minimum: 1
            maximum: 100
        - name: format
          in: query
          required: false
          description: csv returns the page as a CSV file.
          schema:
            description: csv returns the page as a CSV file.
            type: string
            enum:
              - json
              - csv
        - name: scope
          in: query
          required: false
          description: Default index.
          schema:
            description: Default index.
            type: string
            enum:
              - index
              - custom
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        text:
                          type: string
                        intent:
                          type: string
                        scope:
                          type: string
                        cadence:
                          type: string
                        status:
                          type: string
                        demand_weight:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        first_run_date:
                          anyOf:
                            - type: string
                              pattern: ^\d{4}-\d{2}-\d{2}$
                            - type: 'null'
                      required:
                        - id
                        - text
                        - intent
                        - scope
                        - cadence
                        - status
                        - demand_weight
                        - first_run_date
                      additionalProperties: false
                  next_cursor:
                    type:
                      - string
                      - 'null'
                  has_more:
                    type: boolean
                required:
                  - items
                  - next_cursor
                  - has_more
                additionalProperties: false
              example:
                items:
                  - id: '00000000000000000000000001'
                    text: which 3PL software connects to Shopify
                    intent: discover
                    scope: category
                    cadence: daily
                    status: active
                    demand_weight: 2
                    first_run_date: null
                  - id: p_acme_001
                    text: best 3PL software for a growing ecommerce brand
                    intent: compare
                    scope: category
                    cadence: daily
                    status: active
                    demand_weight: 2
                    first_run_date: '2026-10-28'
                  - id: p_acme_002
                    text: best 3PL software for a growing ecommerce brand
                    intent: compare
                    scope: category
                    cadence: daily
                    status: active
                    demand_weight: 2
                    first_run_date: '2026-10-28'
                next_cursor: null
                has_more: false
            text/csv:
              schema:
                type: string
                description: >-
                  With format=csv: one row per item, figures flattened to value,
                  _band, _n and _low_sample columns. The next page is in the
                  Citino-Next-Cursor header.
        '400':
          description: The request is invalid; `error.field` names the parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'No live API key in an `Authorization: Bearer` header.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The key lacks the scope named in the message, or cannot write.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such resource in this key's projects.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Over the key's or the workspace's rate limit; see `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Busy or timed out; retry after `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      x-codeSamples:
        - lang: bash
          label: curl
          source: |-
            curl "https://api.citino.ai/v1/projects/{projectId}/prompts" \
              -H "Authorization: Bearer $CITINO_API_KEY"
        - lang: python
          label: Python
          source: |-
            import os
            import requests

            res = requests.get(
                "https://api.citino.ai/v1/projects/{projectId}/prompts",
                headers={"Authorization": f"Bearer {os.environ['CITINO_API_KEY']}"},
            )
            print(res.json())
        - lang: javascript
          label: JavaScript
          source: >-
            const res = await
            fetch("https://api.citino.ai/v1/projects/{projectId}/prompts", {
              headers: {
                Authorization: `Bearer ${process.env.CITINO_API_KEY}`,
              },
            });

            console.log(await res.json());
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: >-
                validation, unauthorized, forbidden, not_found, conflict,
                plan_limit, rate_limited, busy, query_timeout
            message:
              type: string
            field:
              type: string
            detail:
              type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key from Workspace settings → API keys, sent as `Authorization:
        Bearer <key>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.