Retrieve single pipeline

You can fetch a single pipeline.

 

Request Path Parameters
Parameter Type Required Description
org_id number Yes The unique identifier of your organization
id number Yes The unique identifier of the pipeline

 

Example Request & Response


$ curl https://api.custerem.com/<org_id>/opportunities/pipelines/<id>/ \
-X GET \
-H 'Authorization: X-API-KEY <Your API Key>' \
-H 'Content-Type: application/json' \

 

200 OK

{
    "pipeline": {
        "id": 3,
        "name": "Sales Pipeline",
        "columns": [
            {
                "id": 11,
                "title": "Appointment scheduled",
                "created_at": "2022-02-22T06:38:53.530074Z",
                "column_order": 1,
                "opportunities": [],
                "total": {
                    "one_time": 0,
                    "monthly": 0,
                    "annual": 0,
                    "annualized": 0
                },
                "updated_at": "2022-02-22T06:38:53.530096Z",
                "color": "#ffbd2e"
            },
            {
                "id": 12,
                "title": "Proposal Sent",
                "created_at": "2022-02-22T06:38:53.532157Z",
                "column_order": 2,
                "opportunities": [],
                "total": {
                    "one_time": 0,
                    "monthly": 0,
                    "annual": 0,
                    "annualized": 0
                },
                "updated_at": "2022-02-22T06:38:53.532177Z",
                "color": "#ffbd2e"
            },
            {
                "id": 13,
                "title": "Contract Sent",
                "created_at": "2022-02-22T06:38:53.533369Z",
                "column_order": 3,
                "opportunities": [],
                "total": {
                    "one_time": 0,
                    "monthly": 0,
                    "annual": 0,
                    "annualized": 0
                },
                "updated_at": "2022-02-22T06:38:53.533387Z",
                "color": "#ffbd2e"
            },
            {
                "id": 14,
                "title": "Won",
                "created_at": "2022-02-22T06:38:53.534631Z",
                "column_order": 4,
                "opportunities": [],
                "total": {
                    "one_time": 0,
                    "monthly": 0,
                    "annual": 0,
                    "annualized": 0
                },
                "updated_at": "2022-02-22T06:38:53.534649Z",
                "color": "#88dd88"
            },
            {
                "id": 15,
                "title": "Lost",
                "created_at": "2022-02-22T06:38:53.535680Z",
                "column_order": 5,
                "opportunities": [],
                "total": {
                    "one_time": 0,
                    "monthly": 0,
                    "annual": 0,
                    "annualized": 0
                },
                "updated_at": "2022-02-22T06:38:53.535698Z",
                "color": "#cccccc"
            }
        ],
        "created_at": "2022-02-22T06:38:53.526913Z",
        "updated_at": "2022-02-22T06:38:53.526982Z"
    }
}

 

404 Not Found

{
    "status_code": 404,
    "message": "Pipeline with id 4 not found"
}