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

# List Promotions

> List central promotions for the authenticated organization with filters and offset pagination matching the workspace Promotions listing. Requires `promotions:read`.



## OpenAPI

````yaml /openapi.json get /api/v1/promotions
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.sg
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: agentic-checkout
    description: Merchant-fulfilled agentic checkout
    x-group: Agentic Checkout
  - name: commerce
    description: Root commerce discovery
    x-group: Commerce
  - name: developer-platform
    description: Authenticated developer platform APIs
    x-group: Developer Platform
  - 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, and publish
    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: settlements
    description: settlements
    x-group: Settlements
  - name: ucp
    description: Universal Commerce Protocol
    x-group: UCP
paths:
  /api/v1/promotions:
    get:
      tags:
        - promotions
      summary: List Promotions
      description: >-
        List central promotions for the authenticated organization with filters
        and offset pagination matching the workspace Promotions listing.
        Requires `promotions:read`.
      operationId: get_v1_promotions
      parameters:
        - name: organizationId
          in: query
          required: false
          description: >-
            Optional organization scope for session-authenticated calls. OAuth
            client credentials resolve the organization from the token.
          schema:
            type: string
            maxLength: 120
        - name: q
          in: query
          required: false
          description: Search promotion name.
          schema:
            type: string
            maxLength: 200
        - name: status
          in: query
          required: false
          description: >-
            Effective status filter: `all`, `draft`, `scheduled`, `active`,
            `paused`, `ended`, or `archived`.
          schema:
            type: string
            enum:
              - all
              - draft
              - scheduled
              - active
              - paused
              - ended
              - archived
        - name: marketplace
          in: query
          required: false
          description: >-
            Comma-separated marketplaces, for example
            `shopee,lazada,tiktok,shopify`.
          schema:
            type: string
            maxLength: 200
        - name: store
          in: query
          required: false
          description: >-
            Comma-separated promotion store keys
            (`marketplace:country:storeId`).
          schema:
            type: string
            maxLength: 2000
        - name: sortBy
          in: query
          required: false
          description: Sort field.
          schema:
            type: string
            enum:
              - createdAt
              - name
              - startsAt
              - status
            default: createdAt
        - name: sortDir
          in: query
          required: false
          description: Sort direction.
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
        - name: limit
          in: query
          required: false
          description: Page size. Default 20, max 50.
          schema:
            type: integer
            minimum: 1
            maximum: 50
            default: 20
        - name: offset
          in: query
          required: false
          description: Zero-based pagination offset.
          schema:
            type: integer
            minimum: 0
            default: 0
      responses:
        '200':
          description: Promotions page returned.
          content:
            application/json:
              schema:
                type: object
                required:
                  - items
                  - pagination
                  - summary
                properties:
                  items:
                    type: array
                    items:
                      type: object
                  hasMore:
                    type: boolean
                  nextOffset:
                    type: integer
                  summary:
                    type: object
                  pagination:
                    type: object
                    properties:
                      offset:
                        type: integer
                      limit:
                        type: integer
                      total:
                        type: integer
                      hasMore:
                        type: boolean
                      nextOffset:
                        type:
                          - integer
                          - 'null'
                      maxLimit:
                        type: integer
                      defaultLimit:
                        type: integer
        '401':
          description: Unauthorized
        '403':
          description: Forbidden or missing `promotions:read` scope
        '429':
          description: Rate limit exceeded
        '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.

````