> ## 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.

# Get Products

> List your brand catalog: every active product of the brands you subscribe to, whether or not it has been purchased, ordered by product id. Page with `limit` and `starting_after`. Pass `group_id` for the products in one of your product groups.

[Subtotal Connector tool: list\_products](/docs/connector/tools.md#list_products)

Your brand catalog: every active product of your brands, including co-branded ones, whether or not consumers have bought it yet. These are the same products as the **Products** page in the dashboard. Pass `group_id` (from [List product groups](/docs/api-reference/product-groups/list-product-groups.md)) for the products in one of your groups, like the dashboard's group filter.

Call it with your API key, or with an OAuth access token that includes `purchases:brand_products` (which [partner apps](/docs/partner-apps/introduction.md#fixed-permissions) are granted). A token without it receives `403 insufficient_scope`.


## OpenAPI

````yaml get /products
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers: []
security: []
paths:
  /products:
    get:
      tags:
        - products
      summary: Get Products
      description: >-
        List your brand catalog: every active product of the brands you
        subscribe to, whether or not it has been purchased, ordered by product
        id. Page with `limit` and `starting_after`. Pass `group_id` for the
        products in one of your product groups.
      operationId: get_products_products_get
      parameters:
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 256
              - type: 'null'
            description: >-
              Only products whose description, short description or UPC contains
              this
            title: Search
          description: >-
            Only products whose description, short description or UPC contains
            this
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: The maximum number of products to return
            default: 25
            title: Limit
          description: The maximum number of products to return
        - name: starting_after
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              The product id of the last product you processed. The next one
              returned follows it.
            examples:
              - 01J51S0JYV6N7K1030CV1ZKPR1
            title: Starting After
          description: >-
            The product id of the last product you processed. The next one
            returned follows it.
        - name: group_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Only products in this product group, a `product_group_id` from
              `GET /product-groups`. A group that isn't yours matches no
              products.
            title: Group Id
          description: >-
            Only products in this product group, a `product_group_id` from `GET
            /product-groups`. A group that isn't yours matches no products.
        - 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/GetProductsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    GetProductsResponse:
      properties:
        has_more:
          type: boolean
          title: Has More
          description: Whether more products match after this page
          examples:
            - false
        products:
          items:
            $ref: '#/components/schemas/ProductDetail'
          type: array
          title: Products
          description: Matching products, ordered by product_id
      type: object
      required:
        - has_more
        - products
      title: GetProductsResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ProductDetail:
      properties:
        product_id:
          type: string
          title: Product Id
          description: A unique identifier for the product
          examples:
            - 01J51S0JYV6N7K1030CV1ZKPR1
        description:
          type: string
          title: Description
          description: The product's full name
          examples:
            - Sparkling Water, Lime, 12 fl oz
        short_description:
          anyOf:
            - type: string
            - type: 'null'
          title: Short Description
          description: A shorter display name, when one is known
          examples:
            - Lime Sparkling Water
        upc:
          anyOf:
            - type: string
            - type: 'null'
          title: Upc
          description: The product's UPC, when known
          examples:
            - '012345678905'
        brand_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Brand Id
          description: The product's primary brand
          examples:
            - 01J51S0JYV6N7K1030CV1ZKBR1
        brand_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Brand Name
          description: The primary brand's name
          examples:
            - Acme
        brand_logo_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Brand Logo Url
          description: The primary brand's logo URL, when known
        top_level_category:
          anyOf:
            - type: string
            - type: 'null'
          title: Top Level Category
          description: The product's top-level category, when classified
          examples:
            - BEVERAGE
        groups:
          items:
            $ref: '#/components/schemas/ProductGroupRef'
          type: array
          title: Groups
          description: Your own product groups this product is in
          default: []
      type: object
      required:
        - product_id
        - description
      title: ProductDetail
    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
    ProductGroupRef:
      properties:
        product_group_id:
          type: string
          title: Product Group Id
        name:
          type: string
          title: Name
      type: object
      required:
        - product_group_id
        - name
      title: ProductGroupRef
      description: 'A group as it appears on a product row: identity and display name only.'

````

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