---
title: "List responses"
method: GET
path: "/api/v1/responses"
tags: ["responses"]
---

# List responses

`GET /api/v1/responses`

## Request

- Base URL: `https://pineprompt.com`
- URL: `https://pineprompt.com/api/v1/responses`
- Auth: HTTP bearer

Returns the AI responses collected in the active project, optionally filtered to a single prompt or to the responses that cite a given source URL. The response is paginated, with the newest returned first by default.

## Query parameters

- `page` integer
- `per_page` integer
- `prompt_id` integer
- `source_url_id` integer
- `sort_by` 'created_at' | 'updated_at'
- `sort_order` 'asc' | 'desc'
- `include` string

## Headers

- `Pineprompt-Project-Id` integer, required

## Response `200`

OK

- ResponseList
  - `data` Response[]
    - `id` integer: The unique ID of the response.
    - `prompt_id` integer: The numeric ID of the prompt that produced this response. You may pass this ID to the `prompt_id` filter on the list endpoint.
    - `monitor_id` integer: The numeric ID of the monitor this response ran under.
    - `prompt_text` string: The exact prompt text the platform was given.
    - `platform` string: The AI platform that produced this answer.
    - `model` string: The model identifier reported by the platform.
    - `country` string: The ISO 3166-1 alpha-2 country code the response was run in.
    - `language` string: The language the response was run in.
    - `content` string: The raw markdown content the platform produced.
    - `html` string: The rendered HTML form of the content, suitable for display.
    - `excerpt` string: A whitespace-collapsed plain-text excerpt of the content, suitable for list views.
    - `search_queries` string[], nullable: The web search queries the platform ran while producing this answer, if any.
    - `prompt` Prompt: A prompt is a single question Pineprompt asks the AI platforms on your behalf. An active prompt runs with its monitor once per day; an inactive prompt keeps its history but no longer runs.
      - `id` integer: The unique ID of the prompt.
      - `monitor_id` integer: The ID of the monitor that owns this prompt.
      - `prompt` string: The question text the monitor asks each platform on every run.
      - `is_active` boolean: Whether the prompt will run on each daily run of its monitor.
      - `monitor` Monitor: A monitor is a configured daily run: a set of prompts bound to one or more AI platforms in a chosen country and language. While a monitor is active, Pineprompt runs it once per day on your behalf.
        - `id` integer: The unique ID of the monitor.
        - `project_id` integer: The ID of the project this monitor runs under.
        - `name` string: The display name of the monitor.
        - `platforms` string[]: The AI platforms the monitor runs against.
        - `country` string: The ISO 3166-1 alpha-2 country code.
        - `language` string: The language the monitor runs in.
        - `is_active` boolean: Whether the monitor will run on its next daily run.
        - `project` Project: A project represents a single brand or site you monitor. Its `brand_id` names the own brand, the brand every core metric is computed for.
          - `id` integer: The unique ID of the project.
          - `organization_id` integer: The ID of the organization that owns the project.
          - `name` string: The display name of the project.
          - `brand_id` integer, nullable: The ID of the project's own brand, or null while none has been designated.
          - `organization` Organization: An organization is the top-level billing entity and tenant boundary in Pineprompt. Every project, member, and API key belongs to exactly one organization.
            - `id` integer: The unique ID of the organization.
            - `name` string: The display name of the organization.
            - `created_at` string, date-time: When the organization was created.
            - `updated_at` string, date-time: When the organization was last updated.
          - `created_at` string, date-time: When the project was created.
          - `updated_at` string, date-time: When the project was last updated.
        - `created_at` string, date-time: When the monitor was created.
        - `updated_at` string, date-time: When the monitor was last updated.
      - `created_at` string, date-time: When the prompt was created.
      - `updated_at` string, date-time: When the prompt was last updated.
    - `monitor` Monitor: A monitor is a configured daily run: a set of prompts bound to one or more AI platforms in a chosen country and language. While a monitor is active, Pineprompt runs it once per day on your behalf.
      - `id` integer: The unique ID of the monitor.
      - `project_id` integer: The ID of the project this monitor runs under.
      - `name` string: The display name of the monitor.
      - `platforms` string[]: The AI platforms the monitor runs against.
      - `country` string: The ISO 3166-1 alpha-2 country code.
      - `language` string: The language the monitor runs in.
      - `is_active` boolean: Whether the monitor will run on its next daily run.
      - `project` Project: A project represents a single brand or site you monitor. Its `brand_id` names the own brand, the brand every core metric is computed for.
        - `id` integer: The unique ID of the project.
        - `organization_id` integer: The ID of the organization that owns the project.
        - `name` string: The display name of the project.
        - `brand_id` integer, nullable: The ID of the project's own brand, or null while none has been designated.
        - `organization` Organization: An organization is the top-level billing entity and tenant boundary in Pineprompt. Every project, member, and API key belongs to exactly one organization.
          - `id` integer: The unique ID of the organization.
          - `name` string: The display name of the organization.
          - `created_at` string, date-time: When the organization was created.
          - `updated_at` string, date-time: When the organization was last updated.
        - `created_at` string, date-time: When the project was created.
        - `updated_at` string, date-time: When the project was last updated.
      - `created_at` string, date-time: When the monitor was created.
      - `updated_at` string, date-time: When the monitor was last updated.
    - `project` Project: A project represents a single brand or site you monitor. Its `brand_id` names the own brand, the brand every core metric is computed for.
      - `id` integer: The unique ID of the project.
      - `organization_id` integer: The ID of the organization that owns the project.
      - `name` string: The display name of the project.
      - `brand_id` integer, nullable: The ID of the project's own brand, or null while none has been designated.
      - `organization` Organization: An organization is the top-level billing entity and tenant boundary in Pineprompt. Every project, member, and API key belongs to exactly one organization.
        - `id` integer: The unique ID of the organization.
        - `name` string: The display name of the organization.
        - `created_at` string, date-time: When the organization was created.
        - `updated_at` string, date-time: When the organization was last updated.
      - `created_at` string, date-time: When the project was created.
      - `updated_at` string, date-time: When the project was last updated.
    - `created_at` string, date-time: When the response was recorded.
    - `updated_at` string, date-time: When the response was last updated.
  - `links` PaginationLinks
    - `first` string, nullable
    - `last` string, nullable
    - `prev` string, nullable
    - `next` string, nullable
  - `meta` PaginationMeta
    - `current_page` integer
    - `from` integer, nullable
    - `last_page` integer
    - `path` string
    - `per_page` integer
    - `to` integer, nullable
    - `total` integer
    - `links` PaginationLink[]: The page-link rows, in display order from the first page through the last. The set always opens with a previous link and closes with a next link.
      - `url` string, nullable: The URL for this link, or `null` for the disabled previous and next boundaries.
      - `label` string: The label for this link, either a page number or a localized previous or next caption.
      - `page` integer, nullable: The page number this link points to, or `null` for the disabled previous and next boundaries.
      - `active` boolean: Whether this link is the page currently being returned.

## Other responses

- `400`: Missing project header
- `401`: Unauthorized
- `403`: Missing ability
- `404`: Project not in this organization
- `422`: Validation failed

---

[API](https://skmtc.dev/pineprompt/apis/pineprompt-api.md) · [All operations](https://skmtc.dev/pineprompt/apis/pineprompt-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pineprompt/apis/pineprompt-api/revisions/05dbb5241a27?raw)