Deal pipelines

Retrieve deal pipeline

get/admin/deal_pipelines/{id}

Request

  • Base URL: https://api.pipelinecrm.com/api/v3
  • URL: https://api.pipelinecrm.com/api/v3/admin/deal_pipelines/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header app-key
    • API key in query parameter api_key and API key in query parameter app_key

Path parameters

idinteger required

Deal pipeline ID

Response

Successful Response

idinteger
namestring
defaultboolean

Whether new deals land in this pipeline unless another is chosen

pipeline_typestring nullable
descriptionstring nullable
created_atstring
updated_atstring
has_dealsboolean

Whether any deal sits in this pipeline

count_dealsinteger
won_stageobject nullable

The pipeline's won stage (see Deal stages)

lost_stageobject nullable

The pipeline's lost stage (see Deal stages)

Example response

{
  "id": 3,
  "name": "New Business",
  "pipeline_type": "sales",
  "count_deals": 42
}

Changes

No recorded changes to this operation across all 1 revision of this API.