API Documentation

API Endpoint

Deal Statuses

Deal Statuses

GET /api/v2/deal_statuses
Requestsreturns deal statuses

GET  /api/v2/deal_statuses

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "1733",
      "type": "deal_statuses",
      "attributes": {
        "name": "Qualified Lead",
        "position": 1,
        "color_id": "0",
        "archived_at": null,
        "time_tracking_enabled": true,
        "expense_tracking_enabled": true,
        "booking_tracking_enabled": true,
        "status_id": 1,
        "probability_enabled": false,
        "probability": null,
        "lost_reason_enabled": false,
        "used": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "333"
          }
        },
        "pipeline": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "1734",
      "type": "deal_statuses",
      "attributes": {
        "name": "Needs Defined",
        "position": 2,
        "color_id": "4",
        "archived_at": null,
        "time_tracking_enabled": true,
        "expense_tracking_enabled": true,
        "booking_tracking_enabled": true,
        "status_id": 1,
        "probability_enabled": false,
        "probability": null,
        "lost_reason_enabled": false,
        "used": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "333"
          }
        },
        "pipeline": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "1735",
      "type": "deal_statuses",
      "attributes": {
        "name": "Proposal Sent",
        "position": 3,
        "color_id": "5",
        "archived_at": null,
        "time_tracking_enabled": true,
        "expense_tracking_enabled": true,
        "booking_tracking_enabled": true,
        "status_id": 1,
        "probability_enabled": false,
        "probability": null,
        "lost_reason_enabled": false,
        "used": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "333"
          }
        },
        "pipeline": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "1736",
      "type": "deal_statuses",
      "attributes": {
        "name": "Won Deals",
        "position": 4,
        "color_id": "14",
        "archived_at": null,
        "time_tracking_enabled": false,
        "expense_tracking_enabled": false,
        "booking_tracking_enabled": false,
        "status_id": 2,
        "probability_enabled": false,
        "probability": null,
        "lost_reason_enabled": false,
        "used": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "333"
          }
        },
        "pipeline": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "1737",
      "type": "deal_statuses",
      "attributes": {
        "name": "Lost Deals",
        "position": 5,
        "color_id": "13",
        "archived_at": null,
        "time_tracking_enabled": false,
        "expense_tracking_enabled": false,
        "booking_tracking_enabled": false,
        "status_id": 3,
        "probability_enabled": false,
        "probability": null,
        "lost_reason_enabled": true,
        "used": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "333"
          }
        },
        "pipeline": {
          "meta": {
            "included": false
          }
        }
      }
    },
    {
      "id": "1738",
      "type": "deal_statuses",
      "attributes": {
        "name": "test deal status",
        "position": null,
        "color_id": null,
        "archived_at": null,
        "time_tracking_enabled": true,
        "expense_tracking_enabled": true,
        "booking_tracking_enabled": true,
        "status_id": 1,
        "probability_enabled": false,
        "probability": null,
        "lost_reason_enabled": false,
        "used": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "333"
          }
        },
        "pipeline": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/deal_statuses?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/deal_statuses?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 6,
    "page_size": 30,
    "max_page_size": 200
  }
}

Get deal statuses
GET/api/v2/deal_statuses

GET /api/v2/deal_statuses/1
Requestsreturns deal status

GET  /api/v2/deal_statuses/1744

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1744",
    "type": "deal_statuses",
    "attributes": {
      "name": "test deal status",
      "position": null,
      "color_id": null,
      "archived_at": null,
      "time_tracking_enabled": true,
      "expense_tracking_enabled": true,
      "booking_tracking_enabled": true,
      "status_id": 1,
      "probability_enabled": false,
      "probability": null,
      "lost_reason_enabled": false,
      "used": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "334"
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Gets a deal status
GET/api/v2/deal_statuses/{id}

URI Parameters
HideShow
id
number (required) Example: 1

deal status id

POST /api/v2/deal_statuses
Requestscreates deal statusreturns errorreturns errorcreates deal statusreturns error

POST  /api/v2/deal_statuses

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "deal_statuses",
    "attributes": {
      "name": "test name",
      "position": 1
    },
    "relationships": {
      "pipeline": {
        "data": {
          "type": "pipelines",
          "id": "410"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1751",
    "type": "deal_statuses",
    "attributes": {
      "name": "test name",
      "position": 1,
      "color_id": null,
      "archived_at": null,
      "time_tracking_enabled": true,
      "expense_tracking_enabled": true,
      "booking_tracking_enabled": true,
      "status_id": 1,
      "probability_enabled": false,
      "probability": null,
      "lost_reason_enabled": false,
      "used": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "335"
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/deal_statuses

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "deal_statuses",
    "attributes": {
      "name": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "meta": {},
      "source": {
        "pointer": "data/attributes/name"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "meta": {},
      "source": {
        "pointer": "data/attributes/pipeline"
      }
    }
  ]
}

POST  /api/v2/deal_statuses

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "deal_statuses",
    "attributes": {
      "name": "Probability",
      "probability": 20,
      "probability_enabled": true
    },
    "relationships": {
      "pipeline": {
        "data": {
          "type": "pipelines",
          "id": "421"
        }
      }
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "probability_feature_unavailable",
      "title": "Invalid Attribute",
      "detail": "feature unavailable",
      "meta": {},
      "source": {
        "pointer": "data/attributes/probability"
      }
    }
  ]
}

POST  /api/v2/deal_statuses

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "deal_statuses",
    "attributes": {
      "name": "Probability",
      "probability": 20,
      "probability_enabled": true
    },
    "relationships": {
      "pipeline": {
        "data": {
          "type": "pipelines",
          "id": "423"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1783",
    "type": "deal_statuses",
    "attributes": {
      "name": "Probability",
      "position": null,
      "color_id": null,
      "archived_at": null,
      "time_tracking_enabled": true,
      "expense_tracking_enabled": true,
      "booking_tracking_enabled": true,
      "status_id": 1,
      "probability_enabled": true,
      "probability": 20,
      "lost_reason_enabled": false,
      "used": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "340"
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/deal_statuses

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "deal_statuses",
    "attributes": {
      "name": "Probability",
      "probability_enabled": true
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "meta": {
        "if": {}
      },
      "source": {
        "pointer": "data/attributes/probability"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "meta": {},
      "source": {
        "pointer": "data/attributes/pipeline"
      }
    }
  ]
}

Create a deal status
POST/api/v2/deal_statuses

URI Parameters
HideShow
name
string (required) Example: Name

name

PATCH /api/v2/deal_statuses/1
Requestsupdates deal_statusupdates successfullyreturns errorupdates successfullyupdates probabilityreturns errorupdates probabilityreturns error

PATCH  /api/v2/deal_statuses/1795

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "deal_statuses",
    "attributes": {
      "name": "new name"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1795",
    "type": "deal_statuses",
    "attributes": {
      "name": "new name",
      "position": null,
      "color_id": null,
      "archived_at": null,
      "time_tracking_enabled": true,
      "expense_tracking_enabled": true,
      "booking_tracking_enabled": true,
      "status_id": 1,
      "probability_enabled": false,
      "probability": null,
      "lost_reason_enabled": false,
      "used": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "342"
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deal_statuses/1801

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "deal_statuses",
    "relationships": {
      "pipeline": {
        "data": {
          "type": "pipelines",
          "id": "431"
        }
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1801",
    "type": "deal_statuses",
    "attributes": {
      "name": "prospective",
      "position": null,
      "color_id": null,
      "archived_at": null,
      "time_tracking_enabled": true,
      "expense_tracking_enabled": true,
      "booking_tracking_enabled": true,
      "status_id": 1,
      "probability_enabled": false,
      "probability": null,
      "lost_reason_enabled": false,
      "used": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "343"
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deal_statuses/1837

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "deal_statuses",
    "attributes": {
      "status_id": 3
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "not allowed to change stage status with active deals",
      "meta": {},
      "source": {
        "pointer": "data/attributes/status_id"
      }
    }
  ]
}

PATCH  /api/v2/deal_statuses/1843

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "deal_statuses",
    "attributes": {
      "status_id": 3
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1843",
    "type": "deal_statuses",
    "attributes": {
      "name": "test deal status",
      "position": null,
      "color_id": null,
      "archived_at": null,
      "time_tracking_enabled": true,
      "expense_tracking_enabled": true,
      "booking_tracking_enabled": true,
      "status_id": 3,
      "probability_enabled": false,
      "probability": null,
      "lost_reason_enabled": false,
      "used": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "350"
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deal_statuses/1849

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "deal_statuses",
    "attributes": {
      "probability": 30,
      "probability_enabled": true
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1849",
    "type": "deal_statuses",
    "attributes": {
      "name": "prospective",
      "position": null,
      "color_id": null,
      "archived_at": null,
      "time_tracking_enabled": true,
      "expense_tracking_enabled": true,
      "booking_tracking_enabled": true,
      "status_id": 1,
      "probability_enabled": true,
      "probability": 30,
      "lost_reason_enabled": false,
      "used": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "351"
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deal_statuses/1855

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "deal_statuses",
    "attributes": {
      "probability": 30,
      "probability_enabled": true
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "probability_feature_unavailable",
      "title": "Invalid Attribute",
      "detail": "feature unavailable",
      "meta": {},
      "source": {
        "pointer": "data/attributes/probability"
      }
    }
  ]
}

PATCH  /api/v2/deal_statuses/1861

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "deal_statuses",
    "attributes": {
      "probability": 30,
      "probability_enabled": true
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1861",
    "type": "deal_statuses",
    "attributes": {
      "name": "prospective",
      "position": null,
      "color_id": null,
      "archived_at": null,
      "time_tracking_enabled": true,
      "expense_tracking_enabled": true,
      "booking_tracking_enabled": true,
      "status_id": 1,
      "probability_enabled": true,
      "probability": 30,
      "lost_reason_enabled": false,
      "used": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "353"
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

PATCH  /api/v2/deal_statuses/1867

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "deal_statuses",
    "attributes": {
      "name": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "meta": {},
      "source": {
        "pointer": "data/attributes/name"
      }
    }
  ]
}

Update a deal status
PATCH/api/v2/deal_statuses/{id}

URI Parameters
HideShow
id
number (required) Example: 1

deal status id

PATCH /api/v2/deal_statuses/1/archive
Requestsarchives deal_status

PATCH  /api/v2/deal_statuses/1873/archive

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1873",
    "type": "deal_statuses",
    "attributes": {
      "name": "test deal status",
      "position": null,
      "color_id": null,
      "archived_at": "2026-03-17T05:05:46.000+01:00",
      "time_tracking_enabled": true,
      "expense_tracking_enabled": true,
      "booking_tracking_enabled": true,
      "status_id": 1,
      "probability_enabled": false,
      "probability": null,
      "lost_reason_enabled": false,
      "used": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "355"
        }
      },
      "pipeline": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Archives a deal status
PATCH/api/v2/deal_statuses/{id}/archive

URI Parameters
HideShow
id
number (required) Example: 1

deal status id

PATCH /api/v2/deal_statuses/merge
Requestsdoes not allow deleting status

PATCH  /api/v2/deal_statuses/merge

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "winner_id": 1908,
  "loser_id": 1907
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "deal_status_mismatch",
      "title": "Invalid Attribute",
      "detail": "cannot merge stages with different statuses",
      "meta": {},
      "source": {
        "pointer": "data/attributes/status_id"
      }
    }
  ]
}

Merges a deal status
PATCH/api/v2/deal_statuses/merge

URI Parameters
HideShow
id
number (required) Example: 1

deal status id

DELETE /api/v2/deal_statuses/1
Requestsdestroys deal statusdoes not destroy deal statusdoes not destroy deal statusdoes not destroy deal statusdestroys deal status

DELETE  /api/v2/deal_statuses/1915

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses204
This response has no content.

DELETE  /api/v2/deal_statuses/1922

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses409
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "409",
      "code": "deal_status_in_use",
      "title": "Conflict error",
      "meta": {},
      "source": {}
    }
  ]
}

DELETE  /api/v2/deal_statuses/1929

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses409
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "409",
      "code": "deal_status_in_use",
      "title": "Conflict error",
      "meta": {},
      "source": {}
    }
  ]
}

DELETE  /api/v2/deal_statuses/1933

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "deal_status_last_stage_not_allowed",
      "title": "Invalid Attribute",
      "detail": "must have at least one stage with status 'Won'",
      "meta": {},
      "source": {
        "pointer": "data/attributes/status_id"
      }
    }
  ]
}

DELETE  /api/v2/deal_statuses/1942

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses204
This response has no content.

Destroy a deal status
DELETE/api/v2/deal_statuses/{id}

URI Parameters
HideShow
id
number (required) Example: 1

deal status id

Generated by aglio on 17 Mar 2026