> ## 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. # Get the pipeline > The location’s pipeline: stages in board order with deal counts, the fixed phases, and which system event moves deals into which stage. Use stage ids with `POST /v1/deals/{id}/stage` and the `stage_id` / `phase` filters of `GET /v1/deals`. `manual_entry` tells you whether a stage can be entered by hand. ## OpenAPI ````yaml /openapi/public-v1.json get /v1/pipeline 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 ` 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/pipeline: get: tags: - Deals summary: Get the pipeline description: >- The location’s pipeline: stages in board order with deal counts, the fixed phases, and which system event moves deals into which stage. Use stage ids with `POST /v1/deals/{id}/stage` and the `stage_id` / `phase` filters of `GET /v1/deals`. `manual_entry` tells you whether a stage can be entered by hand. operationId: pipeline_get parameters: [] responses: '200': description: OK content: application/json: schema: type: object required: - data - meta properties: data: $ref: '#/components/schemas/PipelineDto' meta: $ref: '#/components/schemas/EmptyMetaDto' '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: PipelineDto: type: object properties: stages: description: Stages in board order. type: array items: $ref: '#/components/schemas/PipelineStageDto' phases: description: The fixed phases every location shares. type: array items: $ref: '#/components/schemas/PipelinePhaseDto' events: description: System events and the stage each is bound to. type: array items: $ref: '#/components/schemas/PipelineEventDto' counts: $ref: '#/components/schemas/PipelineCountsDto' required: - stages - phases - events - counts EmptyMetaDto: type: object properties: {} ErrorEnvelopeDto: type: object properties: error: $ref: '#/components/schemas/PublicErrorDto' required: - error PipelineStageDto: type: object properties: id: type: string description: >- Stage id. Use it in `POST /v1/deals/{id}/stage` and the `stage_id` list filter. 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 across phases). 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 that moves deals into this stage, when bound. event_label: type: string nullable: true description: Human label of the bound event. is_terminal: type: boolean description: >- True for the Funded and Dead stages (deals do not progress past them). manual_entry: type: string enum: - allowed - blocked - requires_payload description: >- Whether `POST /v1/deals/{id}/stage` with this `stage_id` works: `allowed`; `blocked` (fed by a workflow event only, e.g. first submission sent); `requires_payload` (use `event: mark_funded` / `mark_dead`, or supply the funded offer / reason). color: type: string nullable: true description: Hex colour used on the board. deal_count: type: number description: Deals currently in this stage. required: - id - label - phase - sort_order - event - event_label - is_terminal - manual_entry - color - deal_count PipelinePhaseDto: type: object properties: id: type: string enum: - preoffer - offer - contract - funded - dead description: Phase id, usable as the `phase` deal filter. label: type: string description: Human label. order: type: number description: Order of the phase (0 = first). is_terminal: type: boolean description: True for Funded and Dead. stage_count: type: number description: Stages in this phase. deal_count: type: number description: Deals in this phase. required: - id - label - order - is_terminal - stage_count - deal_count PipelineEventDto: type: object properties: id: type: string enum: - first_submission_sent - first_offer_logged - merchant_accepted_offer - contracts_requested - contracts_sent - contracts_signed - marked_funded - marked_dead description: System event id. label: type: string description: Human label. description: type: string description: When the platform fires it. action: type: string enum: - workflow - modal description: >- `workflow` events fire from platform actions (sending, logging offers, contracts); `modal` events are the funded / dead confirmations. stage_id: type: string nullable: true description: >- Stage the event moves deals into, or null when the location has not bound it. stage_label: type: string nullable: true required: - id - label - description - action - stage_id - stage_label PipelineCountsDto: type: object properties: total: type: number description: Deals with a stage in this location. by_phase: type: object description: Deal counts keyed by phase id. required: - total - by_phase 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 - [Changelog](/changelog/changelog.md) - [MCP server](/mcp/overview.md) - [Overview](/getting-started/overview.md)