Stages
The Stages API provides read-only access to details of your sales pipeline stages.
Stages are key components of a sales pipeline. Each stage can have any number ofDealsassociated with it. When you sign up to Sell, we create a single pipeline with 7 stages which you can freely modify via the web frontend.
The table below shows the default state of the pipeline.
Name | Category | Active | Position | Likelihood |
---|---|---|---|---|
Prospecting | incoming |
true |
1 |
5 |
Qualified | in_progress |
true |
2 |
10 |
Quote | in_progress |
true |
3 |
20 |
Closure | in_progress |
true |
7 |
50 |
Won | won |
false |
8 |
n/a |
Lost | lost |
false |
9 |
n/a |
Unqualified | unqualified |
false |
10 |
n/a |
JSON format
Name | Read Only | Type | Description |
---|---|---|---|
id |
true | number | The unique identifier of the stage. |
name |
false | string | Human-friendly name of the stage. |
category |
false | string | The unique category name of the stage. |
active |
false | boolean | Indicator whether or not the stage contains finalized deals. |
position |
false | number | The stage's position in the pipeline. |
likelihood |
false | number | The likelihood that a deal will be won, set for the stage as percentage. |
pipeline_id |
false | number | Unique identifier of the pipeline that contains this stage. |
created_at |
true | string | Date and time of creation in UTC ISO8601 format. |
updated_at |
true | string | Date and time of last update in UTC ISO8601 format. |
Retrieve all stages
GET/v2/stages
Returns all stages available to the user, according to the parameters provided.
Parameters
Name | Required | Type | In | Description |
---|---|---|---|---|
pipeline_id |
false | number | 查询 | The unique identifier of the pipeline that contains this stage. |
page |
false | number | 查询 | The page number to start from. Page numbering starts at 1, and omitting thepage parameter will return the first page. |
per_page |
false | number | 查询 | The number of records to return per page. The default limit is25and the maximum number that can be returned is100. |
sort_by |
false | string | 查询 | Comma-separated list of fields to sort by. The sort criteria is applied in the order specified. Thedefaultordering isascending. If you want to change the sort ordering to descending, append:desc to the field e.g.sort_by=position:desc . Possible values:pipeline_id ,id ,name ,category ,position ,likelihood |
ids |
false | string | 查询 | Comma-separated list of stage IDs to be returned in a request. |
name |
false | string | 查询 | Name of the stage you're searching for. This parameter is used in a strict sense. |
active |
false | boolean | 查询 | Parameter that determines whether to return active or inactive stages. |
Allowed for
- Agents
Using cURL
旋度-v -X GET https://api.getbase.com/v2/stages?pipeline_id=1\
-H"Accept: application/json"\
-H"Authorization: Bearer$ACCESS_TOKEN"
Example response
HTTP/1.1200OK
Content-Type:application/json; charset=utf-8
Content-Language:en
{
"items":[
{
"data":{
"id":1,
"name":"Prospecting",
"category":"incoming",
"position":1,
"likelihood":5,
"active":true,
"pipeline_id":1,
"created_at":"2015-04-10T13:30:41Z",
"updated_at":"2015-04-10T13:30:41Z"
},
"meta":{
"type":"stage"
}
},
{
"data":{
"id":2,
"name":"Qualified",
"category":"in_progress",
"position":2,
"likelihood":10,
"active":true,
"pipeline_id":1,
"created_at":"2015-04-10T13:30:41Z",
"updated_at":"2015-04-10T13:30:41Z"
},
"meta":{
"type":"stage"
}
},
{
"data":{
"id":3,
"name":"Quote",
"category":"in_progress",
"position":3,
"likelihood":20,
"active":true,
"pipeline_id":1,
"created_at":"2015-04-10T13:30:41Z",
"updated_at":"2015-04-10T13:30:41Z"
},
"meta":{
"type":"stage"
}
},
{
"data":{
"id":4,
"name":"Closure",
"category":"in_progress",
"position":4,
"likelihood":50,
"active":true,
"pipeline_id":1,
"created_at":"2015-04-10T13:30:41Z",
"updated_at":"2015-04-10T13:30:41Z"
},
"meta":{
"type":"stage"
}
},
{
"data":{
"id":5,
"name":"Won",
"category":"won",
"position":5,
"active":false,
"pipeline_id":1,
"created_at":"2015-04-10T13:30:41Z",
"updated_at":"2015-04-10T13:30:41Z"
},
"meta":{
"type":"stage"
}
},
{
"data":{
"id":6,
"name":"Unqualified",
"category":"unqualified",
"position":6,
"active":false,
"pipeline_id":1,
"created_at":"2015-04-10T13:30:41Z",
"updated_at":"2015-04-10T13:30:41Z"
},
"meta":{
"type":"stage"
}
},
{
"data":{
"id":7,
"name":"Lost",
"category":"lost",
"position":7,
"active":false,
"pipeline_id":1,
"created_at":"2015-04-10T13:30:41Z",
"updated_at":"2015-04-10T13:30:41Z"
},
"meta":{
"type":"stage"
}
}
],
"meta":{
"type":"collection",
"count":7,
"links":{
"self":"https://api.getbase.com/v2/stages?per_page=25&page=1"
}
}
}