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

# List product groups

> List your product groups, newest first, as a cursor page. Filter by your own `external_id`.



## OpenAPI

````yaml get /v1/product-groups
openapi: 3.0.0
info:
  title: Creem API
  description: >-
    Creem is an all-in-one platform for managing subscriptions and recurring
    revenue, tailored specifically for today's SaaS companies. It enables you to
    boost revenue, enhance customer retention, and scale your operations
    seamlessly.
  version: v1
  contact:
    name: Creem Support
    url: https://creem.io
    email: support@creem.io
  license:
    name: Commercial
    url: https://creem.io/terms
  termsOfService: https://creem.io/terms
servers:
  - url: https://api.creem.io
    description: Production — live API for processing real transactions and data.
    x-speakeasy-server-id: prod
  - url: https://test-api.creem.io
    description: Test — sandbox API for development and testing with no real charges.
    x-speakeasy-server-id: test
security: []
tags: []
externalDocs:
  description: Creem Documentation
  url: https://docs.creem.io
paths:
  /v1/product-groups:
    get:
      tags:
        - Product Groups
      summary: List product groups
      description: >-
        List your product groups, newest first, as a cursor page. Filter by your
        own `external_id`.
      operationId: listProductGroups
      parameters:
        - name: limit
          required: false
          in: query
          description: Maximum number of product groups to return
          schema:
            minimum: 1
            maximum: 100
            default: 10
            type: number
        - name: starting_after
          required: false
          in: query
          description: 'Cursor for forward pagination: the product group ID to start after'
          schema:
            type: string
        - name: ending_before
          required: false
          in: query
          description: 'Cursor for backward pagination: the product group ID to end before'
          schema:
            type: string
        - name: external_id
          required: false
          in: query
          description: >-
            Only the product group with this `external_id` (your own key).
            Case-sensitive, exact match.
          schema:
            example: plans
            type: string
      responses:
        '200':
          description: Paginated list of product groups
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductGroupListEntity'
        '400':
          description: Bad Request - Invalid input parameters
        '401':
          description: Unauthorized - Invalid or missing API key
        '404':
          description: Not Found - Resource does not exist
      security:
        - ApiKey: []
components:
  schemas:
    ProductGroupListEntity:
      type: object
      properties:
        object:
          type: string
          description: Object type
          example: list
        data:
          description: The product groups of this page.
          type: array
          items:
            $ref: '#/components/schemas/ProductGroupEntity'
        has_more:
          type: boolean
          description: Whether more items exist beyond this page.
      required:
        - object
        - data
        - has_more
    ProductGroupEntity:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the object.
        mode:
          $ref: '#/components/schemas/EnvironmentMode'
        object:
          type: string
          description: >-
            String representing the object's type. Objects of the same type
            share the same value.
          example: product_group
        name:
          type: string
          description: The name of the product group.
        description:
          type: string
          description: A description of the product group.
          nullable: true
        external_id:
          type: string
          description: Your own key for this product group, or `null` when it has none.
          nullable: true
        products:
          description: >-
            The products in the group, in display order. A product is in one
            group at a time.
          type: array
          items:
            $ref: '#/components/schemas/ProductGroupProductEntity'
        upgrades_enabled:
          type: boolean
          description: Whether customers can switch between the products of this group.
        upgrade_behavior:
          type: string
          description: >-
            How a switch between the products is billed, or `null` for the
            default.
          enum:
            - proration-charge-immediately
            - proration-charge
            - proration-none
          nullable: true
        upsells_enabled:
          type: boolean
          description: Whether the products of this group are offered as checkout upsells.
        is_active:
          type: boolean
          description: >-
            Whether the product group is active. Stored and returned; it does
            not yet stop upgrades or upsells.
        created_at:
          format: date-time
          type: string
          description: Creation date of the product group.
          example: '2023-01-01T00:00:00Z'
        updated_at:
          format: date-time
          type: string
          description: Last updated date of the product group.
          example: '2023-01-01T00:00:00Z'
      required:
        - id
        - mode
        - object
        - name
        - description
        - external_id
        - products
        - upgrades_enabled
        - upgrade_behavior
        - upsells_enabled
        - is_active
        - created_at
        - updated_at
    EnvironmentMode:
      type: string
      description: String representing the environment.
      enum:
        - test
        - prod
        - sandbox
    ProductGroupProductEntity:
      type: object
      properties:
        id:
          type: string
          description: The id of the product.
        external_id:
          type: string
          description: Your own key for the product, or `null` when it has none.
          nullable: true
      required:
        - id
        - external_id
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. You can find your API key in the Creem
        dashboard under Settings > API Keys.

````

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