PIPE: Pipeline
The PIPE entity represents a sales pipeline defining deal stages, swimlanes, and custom fields for CRM deal tracking.
Default definition. This article describes the default
PIPE definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches PIPE.Entity properties
| Property | Value |
|---|---|
| Entity code | PIPE |
| Display name | Pipeline |
| Plural | Pipelines |
| Level | 220 |
Use cases
PIPE defines the pipeline configuration for DEAL entities. Each pipeline has ordered columns (stages), swimlanes for categorisation, and configurable custom fields. The columns and fields arrays are stored as objectarrays on the PIPE object. Deals reference their pipeline via an objectLookup and use the column ID as their status value. comboKey is top-level: SUB|ENT.
Fields
General
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Pipeline Name. |
description | text (multi-line) | Description. | |
currency | text | Currency Symbol. | |
defaultProbability | boolean | Auto-set probability from stage. |
Additional panels
- Activity timeline panel attached.
Relationships
- Related lists:
DEALvia formatSUB|PIPE. - Embedded arrays:
array,array. Each entry is a sub-record stored inline on this object.
Creating a Pipeline via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "PIPE",
"level": 220,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example",
"description": "Long description text.",
"currency": "Example text",
"defaultProbability": true
}Listing PIPE records
# All pipelines in your tenant
GET /v1/entities/PIPE/SUB