> ## 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 channels > Paginated list of non-deleted channels with optional filters. Always allowed — `apiLocked` does not block reads. ## OpenAPI ````yaml /api-reference/build.yaml get /channels 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: /channels: get: tags: - Channels summary: List channels description: > Paginated list of non-deleted channels with optional filters. Always allowed — `apiLocked` does not block reads. operationId: listChannels parameters: - in: query name: page schema: type: integer minimum: 1 - in: query name: limit schema: type: integer minimum: 1 maximum: 100 default: 15 - in: query name: sortField schema: type: string - in: query name: sortDirection schema: type: string enum: - asc - desc - in: query name: label schema: type: string description: Substring match on channel label. - in: query name: tagIds style: form explode: true schema: type: array items: type: integer description: Channels that have at least one of the listed tag IDs. - in: query name: status schema: type: integer - in: query name: isPosChannel schema: type: boolean - in: query name: isCustomerSpecific schema: type: boolean - in: query name: isPushOrderToOms schema: type: boolean description: >- When true, filters to channels that have a push-order integration mapping. - in: query name: channelTypes schema: type: string description: >- Comma-separated list of channel types (e.g. `sales_channel,end_to_end_channel`). responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: array items: type: object description: > A sales, fulfillment, or end-to-end channel. Channels carry per-OMS configuration (pull orders, push orders, push stocks, push costs) and an `apiLocked` flag — when locked, mutating operations through the external API return 403. properties: id: type: integer uuid: type: string label: type: string description: type: string nullable: true channelType: type: string enum: - sales_channel - fulfillment_channel - end_to_end_channel apiLocked: type: boolean description: >- When true, PUT/DELETE/integration-products operations on this channel are blocked via the external API. warehouseGroupId: type: integer nullable: true warehouseGroup: type: object nullable: true description: Present when the relation is loaded. additionalProperties: true storeType: type: string nullable: true enabled: type: boolean status: type: integer isPOSChannel: type: boolean nullable: true isCustomerSpecific: type: boolean nullable: true pullOrdersFromOms: type: boolean getProductsEnabled: type: boolean pushInventoryEnabled: type: boolean includeIncomingStocksEnabled: type: boolean pullStocksEnabled: type: boolean pullShipmentsEnabled: type: boolean pushIncomingStocksFromSupplierPurchaseOrderEnabled: type: boolean pushStocksAppIntegrationAccountId: type: integer nullable: true channelIntegrationMapping: type: array description: Present when the relation is loaded. items: type: object additionalProperties: true pullOrderIntegrationMapping: type: object nullable: true description: Present when the relation is loaded. additionalProperties: true pushOrderIntegrationMapping: type: object nullable: true description: Present when the relation is loaded. additionalProperties: true pushStockIntegrationMapping: type: object nullable: true description: Present when the relation is loaded. additionalProperties: true pushCostIntegrationMapping: type: object nullable: true description: Present when the relation is loaded. additionalProperties: true tags: type: array description: Present when the relation is loaded. items: type: object additionalProperties: true metafields: type: array description: >- Present when the relation is loaded. Channel-level settings/metadata key-value pairs. items: type: object additionalProperties: true isDropship: type: boolean nullable: true dropshipSupplierId: type: integer nullable: true dropshipPoDeliveryType: type: string nullable: true dropshipPoDeliveryWarehouseId: type: integer nullable: true dropshipAutoCreatePo: type: boolean nullable: true dropshipAutoSendPo: type: boolean nullable: true dropshipInventoryNotTracked: type: boolean nullable: true autoPushOrderAfterMinutes: type: integer nullable: true autoPushMode: type: string nullable: true filters: type: object nullable: true additionalProperties: true restrictions: type: object nullable: true additionalProperties: true credentials: type: object nullable: true additionalProperties: true fees: type: object nullable: true additionalProperties: true createdAt: type: integer description: Unix timestamp updatedAt: type: integer description: Unix timestamp createdBy: type: integer nullable: true updatedBy: type: integer nullable: true meta: type: object additionalProperties: true links: type: object additionalProperties: 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. ````