Skip to main content

Pipelines

EntityPipeline

Sales pipelines that group phases for Sales Opportunities. Each pipeline defines a set of stages that opportunities progress through.

Endpoints

List

GET/v1/odata/Pipeline

Get by ID

GET/v1/odata/Pipeline({id})

Create

POST/v1/odata/Pipeline

Update

PUT/v1/odata/Pipeline({id})

Delete

DELETE/v1/odata/Pipeline({id})

Fields

FieldTypeDescription
NameStringPipeline name
LocalizedNameStringLocalized pipeline name
CodeStringPipeline code

Relationships

RelationshipTarget EntityCardinalityDescription
SalesOpportunityActivity.SalesOpportunity1:NOpportunities in this pipeline
PhasesDatastore.Phase1:NPipeline phases / stages

Expanding Relationships

GET/v1/odata/Pipeline({id})?$expand=SalesOpportunity
GET/v1/odata/Pipeline({id})/SalesOpportunity