Stages

Supported stage attributes:

Attribute	Type	Description
id	number	Unique identifier of the stage.
name	string	Human-friendly name of the stage.
category	string	The unique category name of the stage.
active	boolean	Indicator whether or not the stage contains finalized deals.
position	number	The stage’s position in the pipeline.
likelihood	number	The likelihood that a deal will be won, set for the stage as percentage.
pipeline_id	number	Unique identifier of the pipeline that contains this stage.
created_at	string	Date and time that the stage was created in UTC (ISO8601 format).

Endpoints

Stream Stage

Read the stream of stage events.

See the Firehose Overview article for more details on request and response formats and parameters.

Action

GET /v3/stages/stream

Examples

Read the stream of stage events

GET /v3/stages/stream?position=tail
Accept: application/json
Authorization: Bearer $ACCESS_TOKEN
User-Agent: $CLIENT_NAME

HTTP/1.1 200 OK
   Content-Type: application/json

{
 "items": [
    {
      "data": {
        "likelihood": 20,
        "name": "Quote",
        "pipeline_id": 299225,
        "active": true,
        "created_at": "2017-09-25T13:12:47Z",
        "position": 3,
        "id": 2992573,
        "category": "in_progress"
      },
      "meta": {
        "event_cause": "interaction",
        "sequence": 1,
        "event_id": "2Z79rjLzTMuLpiqW8XqgvA",
        "event_type": "created",
        "type": "stage",
        "event_time": "2017-09-25T13:12:47Z"
      }
    }
  ],
  "meta": {
    "links": {
      "next": "https://api.getbase.com/v3/stages/stream?position=ZmlyZWhvc2UuZmFjdG9pZC5jb250YWN0LnNuYXBzaG90cywxLDMwNTQ5Mg=="
    },
    "position": "ZmlyZWhvc2UuZmFjdG9pZC5jb250YWN0LnNuYXBzaG90cywxLDMwNTQ5Mg==",
    "top": false
  }
}