Pipeline

GET {{api-domain}}/crm/v2.1/settings/pipeline?layout_id={{layout_id}}

To fetch the details of all or a specific pipeline in the Deals module. For more information, refer to the API documentation.

Request Params

KeyDatatypeRequiredDescription
layout_idstring

RESPONSES

status: OK

{"pipeline":[{"display_value":"Standard (Standard)","default":true,"maps":[{"display_value":"Qualification","sequence_number":1,"forecast_category":{"name":"Pipeline","id":"4150868000000006787"},"actual_value":"Qualification","id":"4150868000000006801","forecast_type":"Open"},{"display_value":"Needs Analysis","sequence_number":2,"forecast_category":{"name":"Pipeline","id":"4150868000000006787"},"actual_value":"Needs Analysis","id":"4150868000000006803","forecast_type":"Open"},{"display_value":"Value Proposition","sequence_number":3,"forecast_category":{"name":"Pipeline","id":"4150868000000006787"},"actual_value":"Value Proposition","id":"4150868000000006805","forecast_type":"Open"},{"display_value":"Identify Decision Makers","sequence_number":4,"forecast_category":{"name":"Pipeline","id":"4150868000000006787"},"actual_value":"Id. Decision Makers","id":"4150868000000006807","forecast_type":"Open"},{"display_value":"Proposal/Price Quote","sequence_number":5,"forecast_category":{"name":"Pipeline","id":"4150868000000006787"},"actual_value":"Proposal/Price Quote","id":"4150868000000006811","forecast_type":"Open"},{"display_value":"Negotiation/Review","sequence_number":6,"forecast_category":{"name":"Pipeline","id":"4150868000000006787"},"actual_value":"Negotiation/Review","id":"4150868000000006813","forecast_type":"Open"},{"display_value":"Closed Won","sequence_number":7,"forecast_category":{"name":"Closed","id":"4150868000000006789"},"actual_value":"Closed Won","id":"4150868000000006815","forecast_type":"Closed Won"},{"display_value":"Closed Lost","sequence_number":8,"forecast_category":{"name":"Omitted","id":"4150868000000006791"},"actual_value":"Closed Lost","id":"4150868000000006817","forecast_type":"Closed Lost"},{"display_value":"Closed-Lost to Competition","sequence_number":9,"forecast_category":{"name":"Omitted","id":"4150868000000006791"},"actual_value":"Closed Lost to Competition","id":"4150868000000006819","forecast_type":"Closed Lost"},{"display_value":"Discount Approved","sequence_number":10,"forecast_category":{"name":"Pipeline","id":"4150868000000006787"},"actual_value":"Discount Approved","id":"4150868000000732001","forecast_type":"Open"},{"display_value":"Discount Rejected","sequence_number":11,"forecast_category":{"name":"Pipeline","id":"4150868000000006787"},"actual_value":"Discount Rejected","id":"4150868000000732004","forecast_type":"Open"},{"display_value":"Contract sent","sequence_number":12,"forecast_category":{"name":"Pipeline","id":"4150868000000006787"},"actual_value":"Contract sent","id":"4150868000000732007","forecast_type":"Closed Won"},{"display_value":"Start","sequence_number":13,"forecast_category":{"name":"Pipeline","id":"4150868000000006787"},"actual_value":"Start","id":"4150868000000732010","forecast_type":"Closed Won"}],"actual_value":"Standard (Standard)","id":"4150868000001874009"},{"display_value":"Option 1","default":false,"maps":[{"display_value":"Qualification","sequence_number":1,"forecast_category":{"name":"Pipeline","id":"4150868000000006787"},"actual_value":"Qualification","id":"4150868000000006801","forecast_type":"Open"},{"display_value":"Proposal/Price Quote","sequence_number":2,"forecast_category":{"name":"Pipeline","id":"4150868000000006787"},"actual_value":"Proposal/Price Quote","id":"4150868000000006811","forecast_type":"Open"}],"actual_value":"Option 1","id":"4150868000001874016"},{"display_value":"Option 2","default":false,"maps":[{"display_value":"Negotiation/Review","sequence_number":1,"forecast_category":{"name":"Pipeline","id":"4150868000000006787"},"actual_value":"Negotiation/Review","id":"4150868000000006813","forecast_type":"Open"}],"actual_value":"Option 2","id":"4150868000001874021"},{"display_value":"436","default":false,"maps":[{"display_value":"Qualification","sequence_number":1,"forecast_category":{"name":"Pipeline","id":"4150868000000006787"},"actual_value":"Qualification","id":"4150868000000006801","forecast_type":"Open"},{"display_value":"Needs Analysis","sequence_number":2,"forecast_category":{"name":"Pipeline","id":"4150868000000006787"},"actual_value":"Needs Analysis","id":"4150868000000006803","forecast_type":"Open"}],"actual_value":"436","id":"4150868000004595013"}]}