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

# List deals

> Deals in the location, newest first, each with its stage, days in stage, primary offer and assignments. Filter by `phase` or `stage_id` (see `GET /v1/pipeline`), `status`, `business_id`, `originator_id`, `paper_grade`, `created_after`, `stale_days` (untouched for N days) and `search`.



## OpenAPI

````yaml /openapi/public-v1.json get /v1/deals
openapi: 3.0.0
info:
  title: NextLevel MCA Public API
  description: >-
    REST API for the NextLevel MCA deal platform. Objects flow Businesses →
    People → Deals → Submissions → Offers → Advances.


    **Authentication.** Send `Authorization: Bearer <key>` with an API key
    (`nlmca_live_…`, created in Settings → Developers) or an OAuth access token.
    Keys are scoped to one location.


    **Conventions.** JSON only. Cursor pagination (`limit` ≤ 100, `cursor` from
    `meta.next_cursor`). Every success is `{ data, meta }`; every error is `{
    error: { type, message, code, param, request_id } }`. POST endpoints accept
    `Idempotency-Key` (24h replay). Rate limit 300 requests/min per credential
    (`X-RateLimit-*` headers).


    **Scopes.** Keys with no scopes have all of them. Otherwise:

    - `businesses:read` — Read businesses and their notes, tasks and activity

    - `businesses:write` — Create and update businesses, notes and tasks

    - `people:read` — Read people (contacts and owners)

    - `people:write` — Create and update people

    - `deals:read` — Read deals, submissions and the pipeline

    - `deals:write` — Create and update deals, move stages

    - `documents:read` — Read documents and statement analysis

    - `documents:write` — Upload documents and request documents from merchants

    - `lenders:read` — Read lenders, criteria and lender matches

    - `lenders:write` — Create and update lenders and criteria

    - `submissions:write` — Submit deals to lenders and withdraw submissions

    - `offers:read` — Read offers

    - `offers:write` — Log and update offers, set the primary offer

    - `advances:read` — Read funded advances and renewal flags

    - `advances:write` — Update advances

    - `portal:send` — Generate and send merchant portal links

    - `webhooks:manage` — Manage webhook subscriptions
  version: '1.0'
  contact: {}
servers:
  - url: https://api.nextlevelmca.com
    description: Production
security:
  - bearer: []
tags:
  - name: Businesses
    description: Merchant businesses and their notes, tasks and activity
  - name: People
    description: Contacts and owners. Phone lookups normalise to E.164.
  - name: Deals
    description: Deals, stage moves, renewals and the pipeline
  - name: Documents
    description: Documents, presigned uploads, document requests and statement analysis
  - name: Lenders
    description: Lenders and their criteria
  - name: Lender matches
    description: Criteria-driven lender matching for a deal
  - name: Submissions
    description: Sending deals to lenders
  - name: Offers
    description: Lender offers and the primary offer
  - name: Advances
    description: Funded advances and renewal readiness
  - name: Merchant portal
    description: Magic links for the merchant portal
  - name: Webhooks
    description: Outbound event subscriptions
paths:
  /v1/deals:
    get:
      tags:
        - Deals
      summary: List deals
      description: >-
        Deals in the location, newest first, each with its stage, days in stage,
        primary offer and assignments. Filter by `phase` or `stage_id` (see `GET
        /v1/pipeline`), `status`, `business_id`, `originator_id`, `paper_grade`,
        `created_after`, `stale_days` (untouched for N days) and `search`.
      operationId: deals_list
      parameters:
        - name: limit
          required: false
          in: query
          description: Page size (1–100).
          schema:
            minimum: 1
            maximum: 100
            default: 25
            type: number
        - name: cursor
          required: false
          in: query
          description: Opaque cursor from a previous response’s `meta.next_cursor`.
          schema:
            type: string
        - name: phase
          required: false
          in: query
          description: >-
            Only deals whose current stage is in this phase: `preoffer`
            (application, submitted), `offer`, `contract`, `funded`, `dead`.
          schema:
            type: string
            enum:
              - preoffer
              - offer
              - contract
              - funded
              - dead
        - name: stage_id
          required: false
          in: query
          description: Only deals in this pipeline stage (ids from `GET /v1/pipeline`).
          schema:
            type: string
        - name: status
          required: false
          in: query
          description: >-
            Deal status slug, e.g. `new`, `submitted`, `approved`, `sold`,
            `funded`, `closed_out`.
          schema:
            type: string
        - name: business_id
          required: false
          in: query
          description: Only deals on this business.
          schema:
            type: string
        - name: originator_id
          required: false
          in: query
          description: Only deals assigned to this originator (user id).
          schema:
            type: string
        - name: paper_grade
          required: false
          in: query
          description: Paper grade, e.g. `A`, `B`, `C`, `D`.
          schema:
            type: string
        - name: created_after
          required: false
          in: query
          description: Only deals created after this ISO 8601 timestamp.
          schema:
            example: '2026-01-01T00:00:00Z'
            type: string
        - name: stale_days
          required: false
          in: query
          description: >-
            Only deals untouched for at least N days: no field change and no
            stage move (measured on `updated_at`, which every stage move
            refreshes). Combine with `phase` to find stuck deals.
          schema:
            minimum: 1
            type: number
        - name: search
          required: false
          in: query
          description: >-
            Fragment matched against business name, DBA and the primary owner’s
            first / last name.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - meta
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/DealDto'
                  meta:
                    $ref: '#/components/schemas/ListMetaDto'
        '400':
          description: Validation failed. `error.param` names the field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelopeDto'
        '401':
          description: Missing, invalid, expired or revoked credential.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelopeDto'
        '403':
          description: Credential lacks the scope, or the role lacks the permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelopeDto'
        '429':
          description: Rate limit exceeded. See `X-RateLimit-*` and `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelopeDto'
      security:
        - bearer: []
components:
  schemas:
    DealDto:
      type: object
      properties:
        id:
          type: string
          description: Deal id.
        business_id:
          type: string
          nullable: true
          description: >-
            Business the deal belongs to (null only for legacy deals that were
            never linked).
        business:
          nullable: true
          description: Linked business summary. Use `include=business` for the full record.
          allOf:
            - $ref: '#/components/schemas/DealBusinessSummaryDto'
        business_name:
          type: string
          nullable: true
          description: Business name as captured on the application.
        dba:
          type: string
          nullable: true
        entity_type:
          type: string
          nullable: true
        industry:
          type: string
          nullable: true
        business_address:
          type: string
          nullable: true
        business_city:
          type: string
          nullable: true
        business_state:
          type: string
          nullable: true
        business_zip:
          type: string
          nullable: true
        business_phone:
          type: string
          nullable: true
        business_start_date:
          type: string
          nullable: true
          description: '`YYYY-MM-DD`.'
        state_incorporated:
          type: string
          nullable: true
        owner:
          nullable: true
          description: >-
            Primary owner as captured on the application. Use `include=people`
            for linked person records.
          allOf:
            - $ref: '#/components/schemas/DealOwnerSummaryDto'
        requested_amount:
          type: number
          nullable: true
          description: Requested funding amount in dollars.
        annual_revenue:
          type: number
          nullable: true
          description: Stated annual revenue in dollars.
        use_of_funds:
          type: string
          nullable: true
        product_type:
          type: string
          nullable: true
          enum:
            - mca
            - term_loan
            - loc
            - equipment
            - factoring
        desired_term_months:
          type: number
          nullable: true
        desired_frequency:
          type: string
          nullable: true
          enum:
            - daily
            - weekly
            - bi-weekly
            - monthly
        paper_grade:
          type: string
          nullable: true
          description: Paper grade `A`–`D`.
        paper_grade_source:
          type: string
          nullable: true
          description: '`computed` (from bank data and risk flags) or `manual` (overridden).'
        risk_flags:
          type: object
          description: >-
            Rep-entered risk facts: `{ prior_default, reversals,
            bankruptcy_months, seasonal, franchise_years }`.
        status:
          type: string
          nullable: true
          description: >-
            Deal status slug (e.g. `new`, `submitted`, `approved`, `sold`,
            `funded`, `closed_out`). Stages are the v2 view of the same
            progression.
        stage:
          nullable: true
          description: Current pipeline stage.
          allOf:
            - $ref: '#/components/schemas/DealStageDto'
        stage_entered_at:
          type: string
          nullable: true
          description: When the deal entered its current stage (ISO 8601 UTC).
        days_in_stage:
          type: number
          nullable: true
          description: Whole days in the current stage.
        primary_offer:
          nullable: true
          description: >-
            The primary offer, when one is set. Its status drives the deal
            status.
          allOf:
            - $ref: '#/components/schemas/DealPrimaryOfferDto'
        originator:
          nullable: true
          description: Assigned originator.
          allOf:
            - $ref: '#/components/schemas/DealUserDto'
        closer:
          nullable: true
          description: Assigned closer.
          allOf:
            - $ref: '#/components/schemas/DealUserDto'
        source:
          type: string
          nullable: true
          description: >-
            How the deal was created: `api`, `user_created`, `embed_form`,
            `workflow`, `renewal`, …
        lead_source:
          type: string
          nullable: true
          description: Where the lead came from, free text.
        form_data:
          type: object
          description: >-
            Application form data keyed by field key (custom fields included).
            Keys that look like SSNs, tax ids, bank account or routing numbers,
            passwords or secrets are removed. Update with a merge-patch via
            `PATCH /v1/deals/{id}`.
        submissions_count:
          type: number
          description: Number of lender submissions.
        offers_count:
          type: number
          description: Number of offers logged.
        renewal_of_deal_id:
          type: string
          nullable: true
          description: 'For renewals: the deal being renewed.'
        renewal_of_advance_id:
          type: string
          nullable: true
          description: 'For renewals: the advance being renewed.'
        manually_closed:
          type: boolean
          description: True when the deal was closed manually after funding.
        closed_at:
          type: string
          nullable: true
          description: ISO 8601 UTC.
        closed_reason:
          type: string
          nullable: true
          description: Reason given when the deal was marked dead.
        ghl_contact_id:
          type: string
          nullable: true
          description: CRM contact id of the primary owner. Read-only.
        ghl_opportunity_id:
          type: string
          nullable: true
          description: CRM opportunity id, when one exists. Read-only.
        created_at:
          type: string
          description: ISO 8601 UTC.
        updated_at:
          type: string
          description: ISO 8601 UTC.
      required:
        - id
        - business_id
        - business
        - business_name
        - dba
        - entity_type
        - industry
        - business_address
        - business_city
        - business_state
        - business_zip
        - business_phone
        - business_start_date
        - state_incorporated
        - owner
        - requested_amount
        - annual_revenue
        - use_of_funds
        - product_type
        - desired_term_months
        - desired_frequency
        - paper_grade
        - paper_grade_source
        - risk_flags
        - status
        - stage
        - stage_entered_at
        - days_in_stage
        - primary_offer
        - originator
        - closer
        - source
        - lead_source
        - form_data
        - submissions_count
        - offers_count
        - renewal_of_deal_id
        - renewal_of_advance_id
        - manually_closed
        - closed_at
        - closed_reason
        - ghl_contact_id
        - ghl_opportunity_id
        - created_at
        - updated_at
    ListMetaDto:
      type: object
      properties:
        next_cursor:
          type: string
          nullable: true
          description: Pass as `?cursor=` to fetch the next page. `null` on the last page.
        has_more:
          type: boolean
      required:
        - next_cursor
        - has_more
    ErrorEnvelopeDto:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/PublicErrorDto'
      required:
        - error
    DealBusinessSummaryDto:
      type: object
      properties:
        id:
          type: string
          description: Business id.
        legal_name:
          type: string
          description: Legal name.
        dba:
          type: string
          nullable: true
      required:
        - id
        - legal_name
        - dba
    DealOwnerSummaryDto:
      type: object
      properties:
        first_name:
          type: string
          nullable: true
        last_name:
          type: string
          nullable: true
        email:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
      required:
        - first_name
        - last_name
        - email
        - phone
    DealStageDto:
      type: object
      properties:
        id:
          type: string
          description: Stage id.
        label:
          type: string
          description: Label as shown on the board.
        phase:
          type: string
          enum:
            - preoffer
            - offer
            - contract
            - funded
            - dead
          description: Phase the stage belongs to.
        sort_order:
          type: number
          description: Board order (ascending).
        event:
          type: string
          nullable: true
          enum:
            - first_submission_sent
            - first_offer_logged
            - merchant_accepted_offer
            - contracts_requested
            - contracts_sent
            - contracts_signed
            - marked_funded
            - marked_dead
          description: System event bound to this stage, when it is event-driven.
      required:
        - id
        - label
        - phase
        - sort_order
        - event
    DealPrimaryOfferDto:
      type: object
      properties:
        id:
          type: string
          description: Offer id.
        lender_id:
          type: string
          nullable: true
        lender_name:
          type: string
          nullable: true
        amount:
          type: number
          nullable: true
          description: Offered amount in dollars.
        factor_rate:
          type: number
          nullable: true
        status:
          type: string
          nullable: true
          description: >-
            Offer status slug, e.g. `new_offer`, `sold`, `contracts_out`,
            `funded`.
      required:
        - id
        - lender_id
        - lender_name
        - amount
        - factor_rate
        - status
    DealUserDto:
      type: object
      properties:
        id:
          type: string
          description: User id.
        name:
          type: string
          description: Display name.
      required:
        - id
        - name
    PublicErrorDto:
      type: object
      properties:
        type:
          type: string
          enum:
            - validation_error
            - authentication_error
            - permission_error
            - not_found
            - conflict
            - rate_limit_error
            - api_error
        message:
          type: string
          description: Human-readable explanation, safe to show to an operator or an agent.
        code:
          type: string
          description: >-
            Stable machine-readable code, e.g. `missing_scope`,
            `duplicate_business`.
        param:
          type: string
          description: Request field the error refers to, when applicable.
        request_id:
          type: string
          description: Echo of the `X-Request-Id` header. Quote it when contacting support.
      required:
        - type
        - message
        - request_id
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: API key or JWT
      type: http
      description: API key (`nlmca_live_…`) or OAuth access token

````

## Related topics

- [List deal notes](/api-reference/deals/list-deal-notes.md)
- [List deal tasks](/api-reference/deals/list-deal-tasks.md)
- [Changelog](/changelog/changelog.md)
