> ## 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 deals > List CRM deals with optional filters and pagination. ## OpenAPI ````yaml /api-reference/build.yaml get /deals 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: /deals: get: tags: - Deals summary: List deals description: List CRM deals with optional filters and pagination. operationId: getDeals parameters: - in: query name: limit schema: type: integer default: 25 maximum: 200 description: Number of records per page. - in: query name: page schema: type: integer description: Page number. - in: query name: pipeline_id schema: type: integer description: Restrict to a specific pipeline. - in: query name: stage_id schema: type: integer description: Restrict to a specific pipeline stage. - in: query name: status schema: type: string enum: - open - won - lost description: Restrict to deals in this status. - in: query name: business_account_id schema: type: integer description: Restrict to deals on a specific company. responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: array items: type: object properties: id: type: integer name: type: string status: type: string enum: - open - won - lost amount: type: number format: float expected_close_date: type: string format: date nullable: true closed_at: type: string format: date-time nullable: true lost_reason: type: string nullable: true stage_changed_at: type: string format: date-time nullable: true description: >- When the deal last moved to its current pipeline stage. Used to compute time-in-stage. notes: type: string nullable: true business_account_id: type: integer nullable: true primary_contact_id: type: integer nullable: true owner_id: type: integer nullable: true deal_pipeline_id: type: integer deal_pipeline_stage_id: type: integer sales_orders_count: type: integer invoices_count: type: integer bills_count: type: integer purchase_orders_count: type: integer work_orders_count: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time '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. ````