> ## 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. # Warehouse groups > Get a paginated list of warehouse groups. ## OpenAPI ````yaml /api-reference/build.yaml get /warehouse-groups 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: Purchase Orders description: Get and modify purchase orders - 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: /warehouse-groups: get: tags: - Locations summary: Warehouse groups description: Get a paginated list of warehouse groups. operationId: getWarehouseGroups parameters: - in: query name: page schema: type: integer default: 1 description: Page number for pagination - in: query name: per_page schema: type: integer default: 10 maximum: 100 description: Number of items per page (max 100) - in: query name: name schema: type: string description: Filter by warehouse group name (partial match) responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: integer description: Warehouse group ID uuid: type: string description: Warehouse group UUID name: type: string description: Warehouse group name description: type: string nullable: true description: Warehouse group description externally_managed: type: boolean description: > Whether this warehouse group's inventory is managed by an external WMS (e.g. a 3PL integration). When `true`, the related `externally_managed_*` and `pull_*` fields drive the integration sync. externally_managed_app_integration_account_id: type: integer nullable: true description: > ID of the app integration account that owns this warehouse group. Required when `externally_managed` is `true`. externally_managed_warehouse: type: string nullable: true description: > External WMS-side warehouse identifier (free-form string from the integration partner). app_integration_account_inventory_location_id: type: integer nullable: true description: > ID of the inventory location within the app integration account that this warehouse group maps to. pull_stocks: type: boolean description: > Whether stock levels are pulled from the external WMS into Luminous. Required to be set when `externally_managed` is `true`. pull_shipments: type: boolean description: > Whether shipments are pulled from the external WMS into Luminous. Required to be set when `externally_managed` is `true`. warehouses: type: array description: Warehouses belonging to this group items: type: object properties: id: type: integer description: Warehouse ID status: type: string nullable: true description: Warehouse status (e.g. active, inactive) name: type: string description: Warehouse name address: type: string nullable: true description: Street address street_address_1: type: string nullable: true description: Street address line 1 street_address_2: type: string nullable: true description: Street address line 2 city: type: string nullable: true description: City state: type: string nullable: true description: State/province zip: type: string nullable: true description: Postal/ZIP code country: type: string nullable: true description: Country is_pick_location: type: boolean description: Whether this warehouse is a pick location created_at: type: string format: date-time description: When the warehouse was created updated_at: type: string format: date-time description: When the warehouse was last updated default_warehouse: description: The default warehouse for this group nullable: true allOf: - type: object properties: id: type: integer description: Warehouse ID status: type: string nullable: true description: Warehouse status (e.g. active, inactive) name: type: string description: Warehouse name address: type: string nullable: true description: Street address street_address_1: type: string nullable: true description: Street address line 1 street_address_2: type: string nullable: true description: Street address line 2 city: type: string nullable: true description: City state: type: string nullable: true description: State/province zip: type: string nullable: true description: Postal/ZIP code country: type: string nullable: true description: Country is_pick_location: type: boolean description: Whether this warehouse is a pick location created_at: type: string format: date-time description: When the warehouse was created updated_at: type: string format: date-time description: When the warehouse was last updated created_at: type: string format: date-time description: When the warehouse group was created updated_at: type: string format: date-time description: When the warehouse group was last updated meta: type: object properties: current_page: type: integer description: The current page number example: 1 from: type: integer description: The starting index of the paginated results example: 1 last_page: type: integer description: The last page number example: 5 per_page: type: integer description: Number of items per page example: 10 to: type: integer description: The ending index of the paginated results example: 10 total: type: integer description: Total number of items across all pages example: 50 '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. ````