Pipelines
The Pipelines API provides a read only interface to your sales pipeline definition.
Sales pipelines consist of a sequence of Stages. When you sign up to Sell, we create a single pipeline.
Properties
| Attribute | Description |
|---|---|
| id number readonly |
The unique identifier of the pipeline. |
| name string |
Human-friendly name of the pipeline. |
| created_at string readonly |
Date and time of creation in UTC ISO8601 format. |
| updated_at string readonly |
Date and time of last update in UTC ISO8601 format. |
| disabled boolean |
Indicator whether or not the pipeline is disabled. You cannot add deals to the disabled pipeline. |
Endpoints
Retrieve all pipelines
Returns all pipelines available to the user, according to the parameters provided.
Parameters
| Attribute | Description |
|---|---|
| page number optional |
The page number to start from. Page numbering starts at 1, and omitting the
e.g.
?page=2
|
| per_page number optional |
The number of records to be returned per page. The default limit is 25 and the maximum number that can be returned is 100.
e.g.
?per_page=20
|
| sort_by string optional |
Comma-separated list of fields to sort by. The sort criteria is applied in the order specified. The default ordering is ascending. If you want to change the sort ordering to descending, append Possible values:
e.g.
?sort_by=name
|
| ids string optional |
Comma-separated list of pipeline IDs to be returned in a request.
e.g.
?ids=1,2,3
|
| name string optional |
Name of the pipeline to search for. This parameter is used in a strict sense.
e.g.
?name=Default%20Sales%20Pipeline
|
| disabled boolean optional |
Parameter that determines whether to return disabled or enabled pipelines.
e.g.
?disabled=false
|