GET /pipelines/{pipeline_id}

Get a specific pipeline

Returns one pipeline with its ordered stages. Each stage has a numeric stage position and a label; a pipeline holds between one and nine stages. default reflects whether it is your own default pipeline.

Path parameters

Name	Type	Description
`pipeline_id` req	string	Pipeline ID

Responses

200 OK

statusintegerint32
Response code
messagestring
Response message
timestampintegerunix-timestamp
Response time
dataobject
object fields →
- pipelineobject
  Information about the sales process of products or services, including deal stages.
  object fields →
  idstringbson-id
  ID of the pipeline
  namestring
  Name of the pipeline
  typestring
  Type of the pipeline (sales or delivery)
  defaultboolean
  Is this pipeline the default pipeline in the account?
  won_column_enabledboolean
  Specifies if the `WON` column is enabled for the pipeline
  won_column_namestring
  Name of the `WON` column for the pipeline
  stagesarray<object>
  Deal stages defined for the pipeline
  array item fields →
  stageintegerint32
  Integer in the range 0 to 100 (exclusive) indicating how close a deal is to being closed
  labelstring
  Text description for the deal stage of the deal

Standard error responses: 400 · 401 · 403 · 404 · 409 · 500 — shared across the API. See Errors.

Related guides

GET /pipelines/{pipeline_id}

curl "https://app.onepagecrm.com/api/v3/pipelines/{pipeline_id}" \
  -u $user_id:$api_key

200 example response

{
  "status": 0,
  "message": "OK",
  "timestamp": 1528373119,
  "data": {
    "pipeline": {
      "id": "5c96306b849d78b896b6f8ca",
      "name": "Default pipeine",
      "type": "sales",
      "default": true,
      "won_column_enabled": false,
      "won_column_name": "Payment",
      "stages": [
        {
          "stage": 80,
          "label": "Negotiation"
        }
      ]
    }
  }
}