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

# List action items

> Returns paginated action items for the project. Defaults to non-dismissed actions (page 1, size 50). Pass status=dismissed with an optional startDate to fetch dismissed actions.



## OpenAPI

````yaml /v2/openapi.json get /actions
openapi: 3.0.0
info:
  title: Promptwatch API v2
  description: >-
    API v2 for customer integrations with Promptwatch monitoring platform. This
    version provides improved structure, additional endpoints, and enhanced
    functionality.
  version: 2.0.0
  contact:
    name: Promptwatch Support
    email: team@promptwatch.com
    url: https://promptwatch.com
  license:
    name: Commercial
    url: https://promptwatch.com/terms-and-conditions
servers:
  - url: https://server.promptwatch.com/api/v2
    description: Promptwatch API v2
security: []
tags:
  - name: Authentication
    description: API key validation and authentication
  - name: Content
    description: >-
      AI content generation and optimization. Create content asynchronously and
      poll for results.
  - name: Content Gap
    description: Content gap analysis and recommendations
  - name: Models
    description: Available LLM models
  - name: Monitors
    description: Monitor management and CRUD operations
  - name: Page Tracker
    description: Track URLs and inspect citation stats, responses, and prompts
  - name: Prompts
    description: Prompt management and operations
  - name: Query Fanouts
    description: ChatGPT query fanout keywords
  - name: Responses
    description: LLM response data and analytics
  - name: Tags
    description: Tag management for prompts
  - name: Topics
    description: Topic management for prompts
  - name: Actions
    description: Action items (GEO suggestions and tasks)
  - name: Personas
    description: Persona configuration for monitors
  - name: Brands
    description: Brand management for competitive analysis
  - name: Visibility
    description: Brand visibility time series and competitor heatmaps
  - name: Citations
    description: Citation analytics from AI responses
  - name: Analytics
    description: Visitor analytics, AI crawler logs, sentiment, and brand visibility trends
  - name: Projects
    description: Project management (organization-level keys only)
  - name: Sitemap
    description: Sitemap crawl progress and discovered URLs
  - name: Site Health
    description: >-
      Crawled pages with SEO issues (titles, meta descriptions, H1, thin
      content)
  - name: Socials
    description: >-
      Social media citations (Reddit posts and YouTube videos) found in LLM
      responses
paths:
  /actions:
    get:
      tags:
        - Actions
      summary: List action items
      description: >-
        Returns paginated action items for the project. Defaults to
        non-dismissed actions (page 1, size 50). Pass status=dismissed with an
        optional startDate to fetch dismissed actions.
      operationId: listActionItems
      parameters:
        - schema:
            anyOf:
              - type: string
                enum:
                  - suggested
                  - dismissed
                  - todo
                  - in_progress
                  - done
              - type: array
                items:
                  type: string
                  enum:
                    - suggested
                    - dismissed
                    - todo
                    - in_progress
                    - done
          in: query
          name: status
          required: false
          description: >-
            Filter by status. Repeat for multiple: status=suggested&status=todo.
            Pass status=dismissed to fetch dismissed actions.
        - schema:
            anyOf:
              - type: string
                enum:
                  - WEBSITE_PERFORMANCE
                  - WEBSITE_HEALTH
                  - CONTENT_GAP
                  - SENTIMENT
                  - REDDIT_SOCIAL
                  - SETUP
                  - UNTRACKED_PAGE
                  - UNTAPPED_PAGE
                  - OFFSITE_MENTION
              - type: array
                items:
                  type: string
                  enum:
                    - WEBSITE_PERFORMANCE
                    - WEBSITE_HEALTH
                    - CONTENT_GAP
                    - SENTIMENT
                    - REDDIT_SOCIAL
                    - SETUP
                    - UNTRACKED_PAGE
                    - UNTAPPED_PAGE
                    - OFFSITE_MENTION
          in: query
          name: type
          required: false
          description: >-
            Filter by action type. Repeat for multiple:
            type=SETUP&type=CONTENT_GAP
        - schema:
            anyOf:
              - type: string
                enum:
                  - critical
                  - high
                  - medium
                  - low
              - type: array
                items:
                  type: string
                  enum:
                    - critical
                    - high
                    - medium
                    - low
          in: query
          name: severity
          required: false
          description: >-
            Filter by severity. Repeat for multiple:
            severity=critical&severity=high
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
          in: query
          name: size
          required: false
          description: Page size (default 50, max 200)
        - schema:
            type: integer
            default: 1
            minimum: 1
          in: query
          name: page
          required: false
          description: Page number (1-based, default 1)
        - schema:
            type: string
            format: date
          in: query
          name: startDate
          required: false
          description: >-
            Return dismissed actions dismissed on or after this date
            (YYYY-MM-DD, UTC). Only applied when status=dismissed. Defaults to
            the last 14 days when omitted.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  actions:
                    - id: 6ba7b820-9dad-11d1-80b4-00c04fd430c8
                      projectId: 6ba7b821-9dad-11d1-80b4-00c04fd430c8
                      type: SETUP
                      status: todo
                      severity: high
                      title: Connect your sitemap
                      description: Add a sitemap so we can crawl your site.
                      reasoning: ''
                      geoImpact: null
                      data:
                        type: SETUP
                        setupType: SITEMAP
                        status: NOT_CONFIGURED
                      completedAt: null
                      dismissedAt: null
                      createdAt: '2026-06-01T12:00:00.000Z'
                      updatedAt: '2026-06-01T12:00:00.000Z'
                  total: 1
                  page: 1
                  size: 50
                  totalPages: 1
                properties:
                  actions:
                    type: array
                    items:
                      type: object
                      example:
                        id: 6ba7b820-9dad-11d1-80b4-00c04fd430c8
                        projectId: 6ba7b821-9dad-11d1-80b4-00c04fd430c8
                        type: SETUP
                        status: todo
                        severity: high
                        title: Connect your sitemap
                        description: Add a sitemap so we can crawl your site.
                        reasoning: ''
                        geoImpact: null
                        data:
                          type: SETUP
                          setupType: SITEMAP
                          status: NOT_CONFIGURED
                        completedAt: null
                        dismissedAt: null
                        createdAt: '2026-06-01T12:00:00.000Z'
                        updatedAt: '2026-06-01T12:00:00.000Z'
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: Action item identifier
                        projectId:
                          type: string
                          format: uuid
                          description: Project identifier
                        type:
                          type: string
                          enum:
                            - WEBSITE_PERFORMANCE
                            - WEBSITE_HEALTH
                            - CONTENT_GAP
                            - SENTIMENT
                            - REDDIT_SOCIAL
                            - SETUP
                            - UNTRACKED_PAGE
                            - UNTAPPED_PAGE
                            - OFFSITE_MENTION
                          description: Action type
                        status:
                          type: string
                          enum:
                            - suggested
                            - dismissed
                            - todo
                            - in_progress
                            - done
                          description: Action item status
                        severity:
                          type: string
                          nullable: true
                          enum:
                            - critical
                            - high
                            - medium
                            - low
                          description: Priority severity
                        title:
                          type: string
                          nullable: true
                          description: Card headline
                        description:
                          type: string
                          nullable: true
                          description: Card body
                        reasoning:
                          type: string
                          nullable: true
                          description: Evidence trail for the suggestion
                        geoImpact:
                          type: string
                          nullable: true
                          description: GEO visibility impact summary
                        data:
                          type: object
                          additionalProperties: true
                          description: >-
                            Type-specific payload (discriminated union on
                            `type`). Drill-down keys: CONTENT_GAP → use
                            `data.promptId` with GET
                            /content-gap/prompts/{promptId}/latest;
                            WEBSITE_HEALTH → GET /site-health (optional
                            issueTypes filter).
                        completedAt:
                          type: string
                          format: date-time
                          description: Timestamp (ISO 8601)
                          nullable: true
                        dismissedAt:
                          type: string
                          format: date-time
                          description: Timestamp (ISO 8601)
                          nullable: true
                        createdAt:
                          type: string
                          format: date-time
                          description: Timestamp (ISO 8601)
                        updatedAt:
                          type: string
                          format: date-time
                          description: Timestamp (ISO 8601)
                      required:
                        - id
                        - projectId
                        - type
                        - status
                        - data
                        - createdAt
                        - updatedAt
                      additionalProperties: false
                    description: >-
                      Action items for the project matching the requested
                      filters
                  total:
                    type: integer
                    description: Total actions matching the filters
                  page:
                    type: integer
                    description: Page number (1-based)
                  size:
                    type: integer
                    description: Page size
                  totalPages:
                    type: integer
                    description: Total pages for this page size
                required:
                  - actions
                  - total
                  - page
                  - size
                  - totalPages
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  error: Bad Request
                  code: DATE_RANGE_TOO_LARGE
                  message: Date range cannot exceed 90 days
                properties:
                  error:
                    type: string
                    description: Error label
                  code:
                    type: string
                    description: Optional machine-readable code (e.g. DATE_RANGE_TOO_LARGE)
                  message:
                    type: string
                    description: Reason the request was rejected
                required:
                  - error
                  - message
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  error: Unauthorized
                  message: Missing or invalid X-API-Key header.
                properties:
                  error:
                    type: string
                    description: Error category (often aligned with HTTP semantics)
                  code:
                    type: string
                    description: Optional machine-readable code
                  message:
                    type: string
                    description: Human-readable explanation
                  details:
                    type: object
                    description: Optional structured detail (e.g. validation)
                    additionalProperties: true
                required:
                  - error
                  - message
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: UNIFIED_ACTION_NOT_FOUND
                  message: Action not found
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                      - UNIFIED_ACTION_NOT_FOUND
                      - INTERNAL_ERROR
                    example: UNIFIED_ACTION_NOT_FOUND
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - code
                  - message
                additionalProperties: false
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key for authentication. Get yours from the Promptwatch dashboard
        under Settings > API Keys.

````