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

# List AI Visibility prompts

> Reads AI Visibility prompts in the selected workspace. Filter with `q`, a JSON object of field matches. Reads only: writes through this route are refused for every entity and every credential.



## OpenAPI

````yaml /openapi.json get /api/entities/VisibilityPrompt
openapi: 3.1.0
info:
  title: Reputably API
  version: 1.0.0
  description: >-
    The HTTP surface an agent credential can reach. It is read plus safe writes:
    you can read your reputation data, generate drafts, queue reports and run
    first-time tracking setup. You cannot send anything to an external platform,
    trigger syncs, touch billing or manage credentials.


    The same endpoints back the MCP server, so anything documented here is
    reachable both ways.
servers:
  - url: https://app.reputably.net
    description: Reputably
  - url: https://your-domain.example
    description: Your own verified white-label domain
security:
  - agentKey: []
tags:
  - name: Businesses
    description: The locations you track, their plan usage and AI-generated insights.
  - name: Reviews
    description: Google and Facebook reviews, including which still need a reply.
  - name: Brand mentions
    description: Mentions across X, Reddit, YouTube, Facebook communities and the open web.
  - name: Brand tracking
    description: The trackers that find mentions, and competitor share of voice.
  - name: Leads
    description: Buying signals detected in mentions, with the public post to reply to.
  - name: AI Visibility
    description: >-
      Whether AI assistants recommend the business, what they cite, and how it
      moves.
  - name: AI Traffic
    description: Which AI crawlers read the website, and who arrives from an AI answer.
  - name: Posts
    description: Google Business Profile posts and drafts.
  - name: Reports
    description: Queued report renders and their CSV output.
  - name: Setup
    description: First-time tracking configuration.
  - name: Account
    description: Workspaces, notifications, sync status and prospect audits.
paths:
  /api/entities/VisibilityPrompt:
    get:
      tags:
        - AI Visibility
      summary: List AI Visibility prompts
      description: >-
        Reads AI Visibility prompts in the selected workspace. Filter with `q`,
        a JSON object of field matches. Reads only: writes through this route
        are refused for every entity and every credential.
      operationId: listVisibilityPrompt
      parameters:
        - name: q
          in: query
          required: false
          schema:
            type: string
          description: JSON filter object, for example {"needs_response":true}.
        - name: sort_by
          in: query
          required: false
          schema:
            type: string
          description: Field to sort on.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: Maximum rows to return.
        - name: skip
          in: query
          required: false
          schema:
            type: integer
          description: Rows to skip, for paging.
        - name: X-Workspace-Id
          in: header
          required: false
          schema:
            type: string
          description: >-
            Which workspace to read. Omit it and you get the account’s home
            workspace, which on an agency account is often not where the live
            businesses are. A workspace this credential cannot read is refused
            with 403 rather than quietly answered from the default.
      responses:
        '200':
          description: Matching AI Visibility prompts.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VisibilityPrompt'
        '401':
          description: Missing or invalid credential.
        '403':
          description: Not readable by this credential, or not in this workspace.
components:
  schemas:
    VisibilityPrompt:
      type: object
      title: VisibilityPrompt
      properties:
        id:
          type: string
          description: Unique id.
        tracker_id:
          type: string
        location_id:
          type: string
          description: Denormalized from the tracker for fast per-business usage counting.
        text:
          type: string
        tag:
          type: string
          description: >-
            Optional single tag (persona / funnel stage). Multi-tag segmentation
            is deferred to v2.
        variations:
          type: array
          items:
            type: string
          description: >-
            LLM-generated alternative phrasings of `text` (same intent,
            different wording — peec.ai style). Each run cycle asks the original
            plus every variation, so the visibility score samples how customers
            actually ask instead of one lucky wording. Generated once by
            runVisibilityTracker on the first run after the prompt is created;
            empty/absent = track the original only.
        variations_generated_at:
          type: string
        is_active:
          type: boolean
  securitySchemes:
    agentKey:
      type: http
      scheme: bearer
      description: >-
        An agent key (`rpk_...`) created in Settings → API & MCP, sent as
        `Authorization: Bearer rpk_...`. Bearer only: a cookie session can never
        drive this API. An OAuth 2.1 access token obtained from the same host
        works identically and lands on the same ceiling.

````