Pipeline

GET {{api-domain}}/crm/v3/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

RESPONSES

status: OK

{"pipeline":[{"display_value":"Standard (Standard)","default":false,"maps":[{"display_value":"Qualification","sequence_number":1,"forecast_category":{"name":"Pipeline","id":"4876876000000006787"},"actual_value":"Qualification","id":"4876876000000006801","forecast_type":"Open"},{"display_value":"Needs Analysis","sequence_number":2,"forecast_category":{"name":"Pipeline","id":"4876876000000006787"},"actual_value":"Needs Analysis","id":"4876876000000006803","forecast_type":"Open"},{"display_value":"Value Proposition","sequence_number":3,"forecast_category":{"name":"Pipeline","id":"4876876000000006787"},"actual_value":"Value Proposition","id":"4876876000000006805","forecast_type":"Open"},{"display_value":"Identify Decision Makers","sequence_number":4,"forecast_category":{"name":"Pipeline","id":"4876876000000006787"},"actual_value":"Id. Decision Makers","id":"4876876000000006807","forecast_type":"Open"},{"display_value":"Proposal/Price Quote","sequence_number":5,"forecast_category":{"name":"Pipeline","id":"4876876000000006787"},"actual_value":"Proposal/Price Quote","id":"4876876000000006811","forecast_type":"Open"},{"display_value":"Negotiation/Review","sequence_number":6,"forecast_category":{"name":"Pipeline","id":"4876876000000006787"},"actual_value":"Negotiation/Review","id":"4876876000000006813","forecast_type":"Open"},{"display_value":"Closed Won","sequence_number":7,"forecast_category":{"name":"Closed","id":"4876876000000006789"},"actual_value":"Closed Won","id":"4876876000000006815","forecast_type":"Closed Won"},{"display_value":"Closed Lost","sequence_number":8,"forecast_category":{"name":"Omitted","id":"4876876000000006791"},"actual_value":"Closed Lost","id":"4876876000000006817","forecast_type":"Closed Lost"},{"display_value":"Closed-Lost to Competition","sequence_number":9,"forecast_category":{"name":"Omitted","id":"4876876000000006791"},"actual_value":"Closed Lost to Competition","id":"4876876000000006819","forecast_type":"Closed Lost"}],"actual_value":"Standard (Standard)","id":"4876876000000883001"},{"display_value":"Conversion Pipeline","default":false,"maps":[{"display_value":"Needs Analysis","sequence_number":1,"forecast_category":{"name":"Pipeline","id":"4876876000000006787"},"actual_value":"Needs Analysis","id":"4876876000000006803","forecast_type":"Open"},{"display_value":"Negotiation/Review","sequence_number":2,"forecast_category":{"name":"Pipeline","id":"4876876000000006787"},"actual_value":"Negotiation/Review","id":"4876876000000006813","forecast_type":"Open"},{"display_value":"Closed Won","sequence_number":3,"forecast_category":{"name":"Closed","id":"4876876000000006789"},"actual_value":"Closed Won","id":"4876876000000006815","forecast_type":"Closed Won"},{"display_value":"Closed Lost","sequence_number":4,"forecast_category":{"name":"Omitted","id":"4876876000000006791"},"actual_value":"Closed Lost","id":"4876876000000006817","forecast_type":"Closed Lost"}],"actual_value":"Conversion Pipeline","id":"4876876000000883009"},{"display_value":"Pipeline2","default":false,"maps":[{"display_value":"Closed Won","sequence_number":1,"forecast_category":{"name":"Closed","id":"4876876000000006789"},"actual_value":"Closed Won","id":"4876876000000006815","forecast_type":"Closed Won"},{"display_value":"Closed Lost","sequence_number":2,"forecast_category":{"name":"Omitted","id":"4876876000000006791"},"actual_value":"Closed Lost","id":"4876876000000006817","forecast_type":"Closed Lost"}],"actual_value":"Pipeline2","id":"4876876000000878014"},{"display_value":"Pipeline3","default":false,"maps":[{"display_value":"Closed Won","sequence_number":1,"forecast_category":{"name":"Closed","id":"4876876000000006789"},"actual_value":"Closed Won","id":"4876876000000006815","forecast_type":"Closed Won"},{"display_value":"Closed Lost","sequence_number":2,"forecast_category":{"name":"Omitted","id":"4876876000000006791"},"actual_value":"Closed Lost","id":"4876876000000006817","forecast_type":"Closed Lost"}],"actual_value":"Pipeline3","id":"4876876000000878024"},{"display_value":"PipelineX","default":false,"maps":[{"display_value":"Closed Won","sequence_number":1,"forecast_category":{"name":"Closed","id":"4876876000000006789"},"actual_value":"Closed Won","id":"4876876000000006815","forecast_type":"Closed Won"},{"display_value":"Closed Lost","sequence_number":2,"forecast_category":{"name":"Omitted","id":"4876876000000006791"},"actual_value":"Closed Lost","id":"4876876000000006817","forecast_type":"Closed Lost"}],"actual_value":"PipelineX","id":"4876876000000878034"},{"display_value":"PipelineXX","default":false,"maps":[{"display_value":"Closed Won","sequence_number":1,"forecast_category":{"name":"Closed","id":"4876876000000006789"},"actual_value":"Closed Won","id":"4876876000000006815","forecast_type":"Closed Won"},{"display_value":"Closed Lost","sequence_number":2,"forecast_category":{"name":"Omitted","id":"4876876000000006791"},"actual_value":"Closed Lost","id":"4876876000000006817","forecast_type":"Closed Lost"}],"actual_value":"PipelineXX","id":"4876876000000939002"},{"display_value":"PipelineY","default":false,"maps":[{"display_value":"Closed Won","sequence_number":1,"forecast_category":{"name":"Closed","id":"4876876000000006789"},"actual_value":"Closed Won","id":"4876876000000006815","forecast_type":"Closed Won"},{"display_value":"Closed Lost","sequence_number":2,"forecast_category":{"name":"Omitted","id":"4876876000000006791"},"actual_value":"Closed Lost","id":"4876876000000006817","forecast_type":"Closed Lost"}],"actual_value":"PipelineY","id":"4876876000000939006"},{"display_value":"PipelineXY","default":false,"maps":[{"display_value":"Closed Won","sequence_number":1,"forecast_category":{"name":"Closed","id":"4876876000000006789"},"actual_value":"Closed Won","id":"4876876000000006815","forecast_type":"Closed Won"},{"display_value":"Closed Lost","sequence_number":2,"forecast_category":{"name":"Omitted","id":"4876876000000006791"},"actual_value":"Closed Lost","id":"4876876000000006817","forecast_type":"Closed Lost"}],"actual_value":"PipelineXY","id":"4876876000001011005"},{"display_value":"PipelineXYZ","default":true,"maps":[{"display_value":"Closed Won","sequence_number":1,"forecast_category":{"name":"Closed","id":"4876876000000006789"},"actual_value":"Closed Won","id":"4876876000000006815","forecast_type":"Closed Won"},{"display_value":"Closed Lost","sequence_number":2,"forecast_category":{"name":"Omitted","id":"4876876000000006791"},"actual_value":"Closed Lost","id":"4876876000000006817","forecast_type":"Closed Lost"}],"actual_value":"PipelineXYZ","id":"4876876000001011009"}]}