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

# List Follow-ups

> Your follow-ups on every conversation, plus every follow-up on `threadId` (whoever left it) when you can open that conversation. Waiting follow-ups come first.

`state` is `waiting`, `fired`, `expired` (it waited past `expiresAt`), `canceled` or `failed` (`failure` says why: its owner lost access, or the conversation was stopped or its last run failed).

### Authorization

Requires `agents:invoke`.



## OpenAPI

````yaml /openapi.json get /api/v1/follow-ups
openapi: 3.1.0
info:
  title: OmniCommerce API
  version: 1.0.0
  license:
    name: Proprietary
    url: https://omnicommerce.sg/terms
  description: >-
    OmniCommerce API surface for agents and developer integrations. Includes
    public endpoints (merchant discovery, product search, compare, catalog, ACO
    retrieval) and authenticated endpoints (product management via API key
    Bearer tokens).
servers:
  - url: https://omnicommerce.ai
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: agentic-checkout
    description: Merchant-fulfilled agentic checkout
    x-group: Agentic Checkout
  - name: agents
    description: agents
    x-group: Agents
  - name: analytics
    description: Sales performance across marketplaces
    x-group: Analytics
  - name: aops
    description: Agent operating procedures
    x-group: AOPs
  - name: branding
    description: branding
    x-group: Branding
  - name: campaigns
    description: Campaign briefs, offer windows, and marketplace runs
    x-group: Campaigns
  - name: catalog
    description: catalog
    x-group: Catalog
  - name: commerce
    description: commerce
    x-group: Commerce
  - name: developer-platform
    description: Authenticated developer platform APIs
    x-group: Developer Platform
  - name: documents
    description: Knowledge base document uploads
    x-group: Knowledge Base
  - name: follow-ups
    description: follow-ups
    x-group: Follow Ups
  - name: inventory
    description: Inventory quantities, planning signals, and marketplace listing absence
    x-group: Inventory
  - name: looks
    description: AI-styled product looks
    x-group: Looks
  - name: oauth
    description: OAuth token endpoints
    x-group: OAuth
  - name: orders
    description: Workspace and agentic orders
    x-group: Orders
  - name: organizations
    description: Organization management
    x-group: Organizations
  - name: price-books
    description: Marketplace list-price markup rules
    x-group: Price Books
  - name: products
    description: Product CRUD, bulk import, enrichment, publish, and delist
    x-group: Products
  - name: promotions
    description: Central promotions and marketplace sync
    x-group: Promotions
  - name: public-agent
    description: Public agent discovery and catalog APIs
    x-group: Public Agent
  - name: returns
    description: returns
    x-group: Returns
  - name: reviews
    description: Marketplace product reviews and seller replies
    x-group: Reviews
  - name: scripts
    description: scripts
    x-group: Scripts
  - name: settlements
    description: settlements
    x-group: Settlements
  - name: ucp
    description: Universal Commerce Protocol
    x-group: UCP
paths:
  /api/v1/follow-ups:
    get:
      tags:
        - follow-ups
      summary: List Follow-ups
      description: >-
        Your follow-ups on every conversation, plus every follow-up on
        `threadId` (whoever left it) when you can open that conversation.
        Waiting follow-ups come first.


        `state` is `waiting`, `fired`, `expired` (it waited past `expiresAt`),
        `canceled` or `failed` (`failure` says why: its owner lost access, or
        the conversation was stopped or its last run failed).


        ### Authorization


        Requires `agents:invoke`.
      operationId: get_v1_follow_ups
      parameters:
        - name: threadId
          in: query
          required: false
          description: Also list every follow-up on this conversation.
          schema:
            type: string
        - name: limit
          in: query
          required: false
          description: 1–50; 20 when omitted.
          schema:
            type: integer
            minimum: 1
            maximum: 50
        - name: organizationId
          in: query
          required: false
          description: >-
            Required for session auth. Optional for API keys, which already
            belong to one organization.
          schema:
            type: string
            maxLength: 120
      responses:
        '200':
          description: The follow-ups.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  operationId:
                    type: string
                  status:
                    type: string
                  data:
                    type: object
                    properties:
                      followUps:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              format: uuid
                            threadId:
                              type: string
                            ownerUserId:
                              type: string
                            state:
                              type: string
                              enum:
                                - waiting
                                - fired
                                - expired
                                - canceled
                                - failed
                            trigger:
                              type: string
                              enum:
                                - schedule
                                - event
                            fireAt:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            eventType:
                              type:
                                - string
                                - 'null'
                            match:
                              type: string
                              description: CEL condition; empty when none
                            note:
                              type: string
                            then:
                              type: string
                              enum:
                                - resume
                                - notify
                            expiresAt:
                              type: string
                              format: date-time
                            firedAt:
                              type:
                                - string
                                - 'null'
                              format: date-time
                            failure:
                              type:
                                - string
                                - 'null'
                            createdAt:
                              type: string
                              format: date-time
                            url:
                              type:
                                - string
                                - 'null'
                              format: uri
                          required:
                            - id
                            - threadId
                            - state
                            - trigger
                            - note
                            - then
                            - expiresAt
        '400':
          description: Invalid payload, or a follow-up the request cannot make.
        '401':
          description: Unauthorized
        '403':
          description: >-
            Missing agents:invoke scope or Assistant access, or an OAuth client
            credential: follow-ups belong to a person (API key or session).
        '500':
          description: Internal Server Error
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Bearer API key for server-to-server access. Session auth is also
        supported in first-party UI flows.

````

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