Get a pipeline by ID

GET

https://api.channelautomation.com/api/pipeline/pipelines/{id}

Authorization

bearerAuth
bearerAuth
required

Path parameters

id
string
required
Pipeline ID

format: uuid

Returns

200

Pipeline details

JSON

success
optional
boolean
data
optional
object
- id
  optional
  string
  Unique pipeline identifier
  
  format: uuid
- name
  optional
  string
  Name of the pipeline
- description
  optional
  string
  Description of the pipeline
- workspace_id
  optional
  string
  Workspace ID this pipeline belongs to
- is_default
  optional
  boolean
  Whether this is the default pipeline
- is_active
  optional
  boolean
  Whether this pipeline is active
- created_at
  optional
  string
  Creation timestamp
  
  format: date-time
- updated_at
  optional
  string
  Last update timestamp
  
  format: date-time
- created_by
  optional
  string
  User ID who created the pipeline
  
  format: uuid
- opportunity_count
  optional
  integer
  Number of opportunities in this pipeline
- total_value
  optional
  number
  Total value of all opportunities in this pipeline
- stages
  optional
  array of
  object
  id
  optional
  string
  Unique stage identifier
  
  format: uuid
  name
  optional
  string
  Name of the stage
  
  position
  optional
  integer
  Order position in the pipeline
  
  color
  optional
  string
  Color code for the stage
  
  default_probability
  optional
  integer
  Default probability percentage for opportunities in this stage
  
  is_won_stage
  optional
  boolean
  Whether this is a won/success stage
  
  is_lost_stage
  optional
  boolean
  Whether this is a lost/failed stage
  
  opportunity_count
  optional
  integer
  Number of opportunities in this stage
}

404

Pipeline not found

500

Internal server error

{ "success": true, "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "workspace_id": "string", "is_default": true, "is_active": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4", "opportunity_count": 0, "total_value": 0, "stages": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "position": 0, "color": "string", "default_probability": 0, "is_won_stage": true, "is_lost_stage": true, "opportunity_count": 0 } ] } }