Opportunity Status
Description
Opportunity Status values are used to track and categorize the progress of Opportunities. This endpoint is typically used to populate dropdowns, filter views, or support integration with opportunity-related workflows.
Resource overview
| Endpoint | Definition |
|---|
GET /OpportunityStatus | Retrieve a list of Opportunity Status records. |
Attributes
| Attribute | Description | Data type | Notes |
|---|
| OpportunityStatusID | Unique identifier for the status | integer | Required |
| OpportunityStatus | Internal status code or label | string | Optional; Max length: 20 |
| OpportunityStatusName | Full display name of the status | string | Optional; Max length: 100 |
| OpportunityStage | Internal code for the related Opportunity stage | string | Optional; Max length: 50 |
| OpportunityStageName | Display name for the Opportunity stage | string | Optional; Max length: 100 |
| Active | Indicates whether the status is active | boolean | Required |
| Required | Indicates whether the status is required | boolean | Required |
|