Returns status code

200

Request url

/pipelines?fields=name,href&sort[name]=desc&page=4&perPage=30

Request params

Field nameField typeField description
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma
sorthashEnable sorting using specified field (set as a key) and order (set as a value).
KeyPossible values if fixed
nameasc, desc
pageintegerSpecify which page of results should be returned
perPageintegerSpecify how many results per page should be returned

Example Response

[
    {
        "pipelineId": "pT",
        "name": "My first pipeline",
        "href": "https://api.getresponse.com/v3/pipelines/pT",
        "stages": "https://api.getresponse.com/v3/pipelines/pT/stages"
    },
    {
        "pipelineId": "n3",
        "name": "Sales pipeline",
        "href": "https://api.getresponse.com/v3/pipelines/n3",
        "stages": "https://api.getresponse.com/v3/pipelines/n3/stages"
    }
]

Returns status code

200

Request url

/pipelines/pT?fields=name,href

Request params

Field nameField typeField description
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma

Example Response

{
    "pipelineId": "pT",
    "name": "My first pipeline",
    "href": "https://api.getresponse.com/v3/pipelines/pT",
    "stages": "https://api.getresponse.com/v3/pipelines/pT/stages"
}

Returns status code

200

Request url

/pipelines/pT/stages?fields=type,name

Request params

Field nameField typeField description
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma

Example Response

[
    {
        "stageId": "mAt",
        "type": "open",
        "position": 1,
        "name": "Proposal",
        "href": "https://api.getresponse.com/v3/pipelines/pT/stages/mAt"
    },
    {
        "stageId": "Akt",
        "type": "won",
        "position": 2,
        "name": "Won",
        "href": "https://api.getresponse.com/v3/pipelines/pT/stages/Akt"
    },
    {
        "stageId": "ZTa",
        "type": "lost",
        "position": 3,
        "name": "Lost",
        "href": "https://api.getresponse.com/v3/pipelines/pT/stages/ZTa"
    }
]

Returns status code

200

Request url

/pipelines/pT/stages/mAt?fields=name,href

Request params

Field nameField typeField description
fieldsstringList of fields that should be returned. Id is always returned. Fields should be separated by comma

Example Response

{
    "stageId": "mAt",
    "type": "open",
    "position": 1,
    "name": "Proposal",
    "href": "https://api.getresponse.com/v3/pipelines/pT/stages/mAt"
}