Stages

Fetch all stages


Return all the stages
GET /pipelines/:pipeline_id/stages
pipeline_id Unique identifier of the pipeline Required
page Page number of stages to return. Returns empty array if the page has no stages. If page parameter isn't present, returns the first page Optional
size Number of stages to return in a page. If size parameter isn't present, returns the page with 25 stages Optional
Response Body
[
    {
        "_id": "521f26eccce8b4310e00006c",
        "name": "Closing"
    },
    {
        "_id": "521f26eccce8b4310e00006d",
        "name": "In Negotiation"
    },
    {
        "_id": "521f26eccce8b4310e00006e",
        "name": "Offer"
    },
    {
        "_id": "521f26eccce8b4310e00006f",
        "name": "Contact"
    },
    {
        "_id": "521f26eccce8b4310e000070",
        "name": "Prospect"
    }
]

Show a stage


Show details of an individual stage
GET /pipelines/:pipeline_id/stages/:stage_id
stage_id Unique identifier of the stage Required
pipeline_id Unique identifier of the pipeline Required
Response Body
{
    "_id": "521f26eccce8b4310e000070",
    "name": "Prospect"
}

Update a stage


Update the name of a stage
PUT /stages/:stage_id
stage_id Unique identifier of the stage Required
name Name of the stage Required
Response Body
{
    "_id": "527cd0fbcce8b4ff75000018",
    "name": "Renamed Pipeline"
}