> ## 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. # Customer operational topology snapshot > Returns a read-only snapshot of the tenant's Luminous operational landscape (channels, integrations, warehouses, settings, profile, health signals, etc.). The snapshot is built from read-only queries and stored centrally. When no topology has been built yet, the first request dispatches a background build job and returns **202 Accepted** with a `Retry-After` header. Poll until a **200** is returned. Only one build per tenant runs at a time; concurrent callers receive **202** until the snapshot is stored. ## OpenAPI ````yaml /api-reference/build.yaml get /customer-topology 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: /customer-topology: get: tags: - Customer Topology summary: Customer operational topology snapshot description: > Returns a read-only snapshot of the tenant's Luminous operational landscape (channels, integrations, warehouses, settings, profile, health signals, etc.). The snapshot is built from read-only queries and stored centrally. When no topology has been built yet, the first request dispatches a background build job and returns **202 Accepted** with a `Retry-After` header. Poll until a **200** is returned. Only one build per tenant runs at a time; concurrent callers receive **202** until the snapshot is stored. operationId: getCustomerTopology responses: '200': description: Stored customer topology snapshot content: application/json: schema: type: object properties: data: type: object properties: tenant_id: type: string description: Identifier of the tenant the snapshot belongs to example: acme topology_data: type: object additionalProperties: true description: > Full topology JSON describing the tenant's operational landscape — channels, integrations, warehouses, settings, profile, health signals, etc. The structure is open-ended and may grow over time. brief_md: type: string nullable: true description: Rendered markdown brief derived from `topology_data` example: |- ## Acme operational overview - 3 active channels - 2 warehouses... built_at: type: string format: date-time nullable: true description: When the snapshot was last built example: '2026-06-09T12:00:00Z' degradation_count: type: integer description: >- Count of topology sections that could not be fully built example: 0 required: - tenant_id - topology_data '202': description: Topology build in progress; retry after `retry_after` seconds headers: Retry-After: description: Suggested delay in seconds before retrying schema: type: integer content: application/json: schema: type: object properties: status: type: string example: processing message: type: string example: >- Customer topology is being built. Please retry in a few seconds. retry_after: type: integer description: Suggested delay in seconds before retrying example: 5 '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. ````