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

# List Product Groups

> List your product groups, ordered by name, each with how many products it holds.

[Subtotal Connector tool: list\_product\_groups](/docs/connector/tools.md#list_product_groups)

The groups you organise your [brand catalog](/docs/api-reference/products/get-products.md) into, ordered by name, each with how many products it holds. These are the same groups as the **Products** page in the dashboard, and each product lists its groups in `groups`.

Call it with your API key, or with a [Subtotal Connector](/docs/connector/introduction.md) OAuth token that includes `product_groups:read`. A token without it receives `403 insufficient_scope`. [Partner app](/docs/partner-apps/introduction.md#fixed-permissions) tokens don't include it.


## OpenAPI

````yaml get /product-groups
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers: []
security: []
paths:
  /product-groups:
    get:
      tags:
        - product groups
      summary: List Product Groups
      description: >-
        List your product groups, ordered by name, each with how many products
        it holds.
      operationId: list_product_groups_product_groups_get
      parameters:
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - name: x-api-key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListProductGroupsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ListProductGroupsResponse:
      properties:
        groups:
          items:
            $ref: '#/components/schemas/ProductGroupSummary'
          type: array
          title: Groups
      type: object
      required:
        - groups
      title: ListProductGroupsResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ProductGroupSummary:
      properties:
        product_group_id:
          type: string
          title: Product Group Id
        name:
          type: string
          title: Name
        product_count:
          type: integer
          title: Product Count
        creation_date:
          type: string
          format: date-time
          title: Creation Date
      type: object
      required:
        - product_group_id
        - name
        - product_count
        - creation_date
      title: ProductGroupSummary
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````

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