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

# List product builder profiles

> Return all Product Builder Profiles, ordered by name. Profiles are reusable configurations
that drive a simplified product-create screen and can be referenced from a product create
(via `profile_id` or `profile_slug`) to enforce SKU format, required variant preset /
distribution group / custom fields, and to stamp fixed defaults.

The response is a bare array (not wrapped or paginated).




## OpenAPI

````yaml /api-reference/build.yaml get /product-profiles
openapi: 3.0.0
info:
  title: Luminous API
  version: 1.0.0
  description: API documentation for Luminous
servers:
  - url: https://{companyName}.api.joinluminous.com/external/api/v1
    variables:
      companyName:
        default: companyName
        description: Your company-specific subdomain
security: []
tags:
  - name: Products
    description: Get and manage products
  - name: Pricing
    description: Manage price schedules, levels, and customizations
  - name: BOMs
    description: Manage Bills of Materials (BOMs)
  - name: Labels
    description: Label rendering via Labelary ZPL service
  - name: Companies
    description: Manage business accounts and their associated data
  - name: Contacts
    description: Manage contact information for individuals
  - name: Suppliers
    description: Manage suppliers (factories) — vendors used on purchase orders
  - name: Supplier SKUs
    description: Manage per-supplier SKU and unit-cost overrides for products
  - name: Locations
    description: Manage warehouses and locations
  - name: Inventory
    description: Get and adjust product stock levels
  - name: Lots
    description: Create, update, and delete product lots (batches)
  - name: Transfer Orders
    description: Manage transfer orders
  - name: Fulfillment Orders
    description: Manage fulfillment orders and picklists
  - name: Fulfillment Priority Lists
    description: Configure fulfillment routing priority lists
  - name: Purchase Orders
    description: Get and modify purchase orders
  - name: Supplier Portal
    description: >-
      Read a supplier's response to a purchase order and control the one-click
      portal link
  - name: Receiving Reports
    description: Manage receiving reports
  - name: Payment Obligations
    description: Manage payment obligations for purchase orders
  - name: Sales Orders
    description: Manage sales orders and sales order shipments
  - name: Purgatory
    description: >-
      Inspect and resolve non-posted sales orders in the purgatory staging
      workflow
  - name: PickFlow Shipping
    description: >-
      Provider-agnostic shipping rates, services, packages, and label purchase
      for PickFlow
  - name: Cycle Counts
    description: >-
      Create, drive, and post PickFlow cycle counts — batches, per-warehouse
      sessions, and CSV import/export
  - name: Print Stations
    description: List paired print stations and enqueue print jobs to them
  - name: Invoices
    description: Get and manage invoices
  - name: Work Orders
    description: >-
      Manage work orders — production lifecycle, steps, materials, links,
      shipments, and comments
  - name: Production Batches
    description: Group and manage work orders as production batches
  - name: Bills
    description: >-
      Accounts payable bill management, payments, attachments, allocations, and
      variance
  - name: Prepayments
    description: Manage vendor prepayments and applications
  - name: Vendor Credits
    description: Manage vendor credits and applications
  - name: Vendor Returns
    description: Manage vendor returns and credit generation
  - name: Customer Returns
    description: Manage customer returns (sales returns), receiving, and restock behavior
  - name: Stock Snapshot
    description: Point-in-time stock snapshots with export support
  - name: Consumption
    description: Consumption reports and exports
  - name: Inventory Aging
    description: Cost-layer-based inventory aging reports
  - name: Bills Reports
    description: Accounts payable bills aging reports
  - name: Forecast
    description: Materialized forecast data
  - name: Reports
    description: Close the books, inventory discrepancy, transaction COGS, and EDI reports
  - name: Tags
    description: Add/remove tags across various resources
  - name: Custom Fields
    description: Get and set custom fields across various resources
  - name: Currency
    description: Currency configuration, exchange rates, and conversion
  - name: Integration Mappings
    description: Manage integration mappings for external systems
  - name: Integration Field Mappings
    description: Manage field-level mappings between Luminous and external systems
paths:
  /product-profiles:
    get:
      tags:
        - Products
      summary: List product builder profiles
      description: >
        Return all Product Builder Profiles, ordered by name. Profiles are
        reusable configurations

        that drive a simplified product-create screen and can be referenced from
        a product create

        (via `profile_id` or `profile_slug`) to enforce SKU format, required
        variant preset /

        distribution group / custom fields, and to stamp fixed defaults.


        The response is a bare array (not wrapped or paginated).
      operationId: listProductProfiles
      responses:
        '200':
          description: List of product profiles
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  description: >
                    A Product Builder Profile — a reusable configuration that
                    drives a simplified product-create

                    screen and, when referenced from a product create, enforces
                    its constraints (SKU format,

                    required variant preset / distribution group / custom
                    fields) and stamps its fixed defaults.
                  properties:
                    id:
                      type: integer
                      description: Unique identifier for the profile
                    name:
                      type: string
                      description: >-
                        Human-readable profile name (unique among non-deleted
                        profiles)
                    slug:
                      type: string
                      nullable: true
                      description: >-
                        Optional URL-friendly identifier (unique among
                        non-deleted profiles). Can be used in place of
                        `profile_id` when referencing the profile from a product
                        create via `profile_slug`.
                    is_active:
                      type: boolean
                      description: >-
                        Whether the profile is active. Inactive profiles are
                        ignored by enforcement.
                    config:
                      type: object
                      nullable: true
                      description: >
                        The heterogeneous builder specification for a Product
                        Builder Profile. Unknown keys are

                        permitted so the schema can grow without a code change;
                        the keys enforcement and the builder

                        screen actually read are documented below.
                      properties:
                        sku_format:
                          type: object
                          nullable: true
                          description: >-
                            A regular expression the product SKU must match on
                            create.
                          properties:
                            regex:
                              type: string
                              maxLength: 255
                              description: >-
                                The pattern the SKU must match (validated as a
                                valid regex on save).
                            hint:
                              type: string
                              maxLength: 255
                              description: >-
                                Human-readable hint shown when a SKU fails the
                                format check.
                        required_variant_template:
                          type: object
                          nullable: true
                          description: >-
                            Requires a variant preset (variant options template)
                            on create.
                          properties:
                            mode:
                              type: string
                              enum:
                                - must_pick
                                - fixed
                              description: >
                                `must_pick` — the user must choose a variant
                                preset on the screen.

                                `fixed` — the profile pins the preset; it is
                                coerced onto the product and not shown.
                            variant_template_id:
                              type: integer
                              description: >-
                                The variant preset (template) ID. Required when
                                `mode` is `fixed`.
                        required_distribution_template:
                          type: object
                          nullable: true
                          description: >-
                            Requires a distribution group (grid template) on
                            create.
                          properties:
                            mode:
                              type: string
                              enum:
                                - must_pick
                                - fixed
                              description: >-
                                Same semantics as
                                `required_variant_template.mode`.
                            grid_template_id:
                              type: integer
                              description: >-
                                The distribution (grid) template ID. Required
                                when `mode` is `fixed`.
                        required_category:
                          type: object
                          nullable: true
                          description: >-
                            Requires a product category (and optionally a
                            subcategory) on create.
                          properties:
                            mode:
                              type: string
                              enum:
                                - must_pick
                                - fixed
                              description: >-
                                Same semantics as
                                `required_variant_template.mode`.
                            category_id:
                              type: integer
                              description: >-
                                The product category ID. Required when `mode` is
                                `fixed`.
                            sub_category_id:
                              type: integer
                              description: >-
                                The product subcategory ID (must belong to
                                `category_id`).
                        required_custom_field_ids:
                          type: array
                          nullable: true
                          description: >-
                            Product custom-field IDs that must be provided (a
                            supplied `0` counts as missing).
                          items:
                            type: integer
                        hidden_defaults:
                          type: object
                          nullable: true
                          description: >-
                            Default field values stamped onto the product that
                            the user never sees. Applied only where the caller
                            left the field unset.
                        fields:
                          type: object
                          nullable: true
                          description: >-
                            Controls which product fields the builder screen
                            shows, hides, orders, relabels, or force-requires.
                          properties:
                            visible:
                              type: array
                              items:
                                type: string
                            hidden:
                              type: array
                              items:
                                type: string
                            order:
                              type: array
                              items:
                                type: string
                            labels:
                              type: object
                            required_overrides:
                              type: object
                        context:
                          type: object
                          nullable: true
                          description: Free-form context bag for the builder screen.
                      additionalProperties: true
                    created_at:
                      type: string
                      format: date-time
                      nullable: true
                    updated_at:
                      type: string
                      format: date-time
                      nullable: true
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authenticate using a bearer token. To create a token, navigate to
        /settings/api-tokens and click Create API Token.

````