Deal Statuses

Pipeline stages defining deal outcomes. Each status belongs to a pipeline and has an outcome category (open, won, lost, or delivered). Statuses can enable time tracking, expense tracking, booking tracking, and probability estimation.

Attributes

archived_at string
Response

Timestamp when the pipeline stage was archived, or null if active.

booking_tracking_enabled boolean
Response Request Parameter `filter`

When true, bookings can be tracked for deals in this pipeline stage.

color_id integer
Response Request

The color ID used to visually distinguish this pipeline stage.

created_at object
Parameter `sort`

Timestamp when this pipeline stage was created.

expense_tracking_enabled boolean
Response Request Parameter `filter`

When true, expenses can be tracked for deals in this pipeline stage.

id integer
Parameter `filter` Parameter `sort`

Unique identifier for the pipeline stage.

lost_reason_enabled boolean
Response Request Parameter `filter`

When true, a lost reason must be provided when a deal is moved to this stage.

name string
Response Request Parameter `sort`

The display name of the pipeline stage.

organization organization
Response

The organization this pipeline stage belongs to.

pipeline pipeline
Response

The pipeline this stage belongs to.

pipeline_id integer
Request Parameter `filter` Parameter `sort`

The ID of the pipeline this stage belongs to.

pipeline_type_id integer
Parameter `filter` Enum

Numeric identifier for the pipeline type (1 = sales, 2 = production).

Enum Values (2 values)

  • 1
  • 2
position integer
Response Request Parameter `sort`

The display order position of this stage within the pipeline.

probability integer
Response Request

The default win probability percentage for deals in this stage.

probability_enabled boolean
Response Request Parameter `filter`

When true, win probability is tracked for deals in this pipeline stage.

query string
Parameter `filter`

A saved filter query string applied to this pipeline stage view.

status_id integer
Response Request Parameter `filter` Parameter `sort` Enum

Numeric identifier for the outcome status of this stage (e.g. open, won, lost, delivered).

Enum Values (4 values)

  • 1
    Open
  • 2
    Won
  • 3
    Lost
  • 4
    Delivered
time_tracking_enabled boolean
Response Request Parameter `filter`

When true, time entries can be logged for deals in this pipeline stage.

used boolean
Response

Indicates whether any deals are currently in this pipeline stage.