Pipelines
The Pipelines API provides a read only interface to your sales pipeline definition.
Sales pipelines consist of a sequence ofStages. When you sign up to Sell, a single pipeline is created.
JSON format
| Name | Type | Read only | Description |
|---|---|---|---|
id |
number | true | Unique identifier of the pipeline. |
name |
string | false | Human-friendly name of the pipeline. |
created_at |
string | true | Date and time of when the custom field was created in UTC (ISO8601 format). |
updated_at |
string | true | Date and time of the last update in UTC (ISO8601 format). |
disabled |
boolean | false | Indicator whether or not the pipeline is disabled. You cannot add deals to the disabled pipeline. |
Retrieve all Pipelines
GET/v2/pipelines
Returns all pipelines available to the user, according to the parameters provided.
| Name | Type | In | Required | Description |
|---|---|---|---|---|
page |
number | 查询 | false | Page number to start from. Page numbering starts at 1, and omitting thepageparameter will return the first page. e.g.?page=2 |
per_page |
number | 查询 | false | Number of records to return per page. Default limit is25的最大数量be returned is100. e.g.?per_page=20 |
ids |
number | 查询 | false | Comma-separated list of IDs to be returned in request. e.g.?ids=1,2,3 |
sort_by |
string | 查询 | false | 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:descto the field e.g.sort_by=name:desc. Possible values:id,name |
name |
string | 查询 | false | Name of the pipeline to search for. This parameter is used in a strict sense. e.g.?name=Default%20Sales%20Pipeline |
disabled |
string | 查询 | false | Parameter that determines whether to return disabled or enabled pipelines. e.g.?disabled=false |
Allowed for
- Agents
Using cURL
旋度-v -X GET https://api.getbase.com/v2/pipelines\-H"Accept: application/json"\-H"Authorization: Bearer$ACCESS_TOKEN"
Example response
HTTP/1.1200OKContent-Type:application/json; charset=utf-8Content-Language:en{"items":[{"data":{"id":1,"name":"Default Sales Pipeline","created_at":"2015-04-10T11:43:22Z","updated_at":"2015-04-10T11:43:22Z","disabled":false},"meta":{"type":"pipeline"}}],"meta":{"type":"collection","count":1,"links":{"self":"https://api.getbase.com/v2/pipelines?per_page=25&page=1"}}}