List all pipelines

Retrieve all existing pipelines

By default, deal stages for the pipelines are also returned in the response.

{ "dealGroups": [ { "allgroups": "1", "allusers": "1", "autoassign": "1", "cdate": "2017-01-16T14:51:57-06:00", "currency": "usd", "id": "1", "links": { "dealGroupGroups": "/api/3/dealGroups/1/dealGroupGroups", "dealGroupUsers": "/api/3/dealGroups/1/dealGroupUsers", "stages": "/api/3/dealGroups/1/stages" }, "stages": [ "1", "2" ], "title": "Pipeline A", "udate": "2017-03-01T11:06:32-06:00" }, { "allgroups": "1", "allusers": "1", "autoassign": "0", "cdate": "2017-03-01T14:45:16-06:00", "currency": "usd", "id": "5", "links": { "dealGroupGroups": "/api/3/dealGroups/5/dealGroupGroups", "dealGroupUsers": "/api/3/dealGroups/5/dealGroupUsers", "stages": "/api/3/dealGroups/5/stages" }, "stages": [ "12", "13", "14" ], "title": "Pipeline Yesterday", "udate": "2017-03-01T15:07:18-06:00" } ], "dealStages": [ { "cardRegion1": "title", "cardRegion2": "next-action", "cardRegion3": "show-avatar", "cardRegion4": "contact-fullname-orgname", "cardRegion5": "value", "cdate": "2017-01-20T09:27:32-06:00", "color": "C481DF", "dealOrder": "next-action DESC", "group": "1", "id": "1", "links": { "group": "/api/3/dealStages/1/group" }, "order": "1", "title": "Stage 1", "udate": "2017-03-01T11:06:14-06:00", "width": "280" }, { "cardRegion1": "title", "cardRegion2": "next-action", "cardRegion3": "show-avatar", "cardRegion4": "contact-fullname-orgname", "cardRegion5": "value", "cdate": "2017-01-20T09:27:34-06:00", "color": "00ECC5", "dealOrder": "next-action DESC", "group": "1", "id": "2", "links": { "group": "/api/3/dealStages/2/group" }, "order": "2", "title": "Stage 2", "udate": "2017-03-01T11:06:20-06:00", "width": "280" }, { "cardRegion1": "title", "cardRegion2": "next-action", "cardRegion3": "show-avatar", "cardRegion4": "contact-fullname-orgname", "cardRegion5": "value", "cdate": null, "color": "18D499", "dealOrder": "next-action DESC", "group": "5", "id": "12", "links": { "group": "/api/3/dealStages/12/group" }, "order": "1", "title": "To Contact", "udate": null, "width": "280" }, { "cardRegion1": "title", "cardRegion2": "next-action", "cardRegion3": "show-avatar", "cardRegion4": "contact-fullname-orgname", "cardRegion5": "value", "cdate": null, "color": "32B0FC", "dealOrder": "next-action DESC", "group": "5", "id": "13", "links": { "group": "/api/3/dealStages/13/group" }, "order": "2", "title": "In Contact", "udate": null, "width": "280" }, { "cardRegion1": "title", "cardRegion2": "next-action", "cardRegion3": "show-avatar", "cardRegion4": "contact-fullname-orgname", "cardRegion5": "value", "cdate": null, "color": "E6CE4B", "dealOrder": "next-action DESC", "group": "5", "id": "14", "links": { "group": "/api/3/dealStages/14/group" }, "order": "3", "title": "Follow Up", "udate": null, "width": "280" } ], "meta": { "total": "2" } }
Query Params
string

Filter by pipeline's title. The filter matches any pipeline titles that contain the provided title (i.e. "Contact" matches all of "In Contact", "To Contact", and "Contact Pipeline").

int32

Filter by whether pipelines have deal stages. Can be either 1 or 0. If 1, only pipelines with at least one stage will be returned.

string
Defaults to ASC

Order by Pipeline's title

string
Defaults to ASC

Order by number of deals each pipeline has. If pipelines have same number of deals, pipelines' created dates are used to determine the order.

Responses

Language
Credentials
URL
Choose an example:
application/json