List Opportunity Stages

๐Ÿงพ List Opportunity Stages

Endpoint: GET /api/v3/opportunity-stages

Auth Required: โœ… Yes (Bearer Token)


๐Ÿ“ Description

Retrieves the list of opportunity stages available in the system. Stages represent phases in the sales or engagement lifecycle (e.g., Prospect, Qualified, Closed Won) and are used for tracking and managing opportunity progress.


๐Ÿ” Query Parameters

Parameter Type Required Default Description
includeInactive boolean No โ€” If true, includes inactive opportunity stages.
languageId integer No โ€” Language ID for localized stage names.

๐Ÿ“ค Request Example

GET https://api.briefingedge.com/api/v3/opportunity-stages?includeInactive=false&languageId=1 Authorization: Bearer <token>  

โœ… Success Response (200 OK)

Returns an array of OpportunityStage objects.

Example:

[  {    "StageID": 1,    "Name": "Prospect",    "IsActive": true  },  {    "StageID": 2,    "Name": "Qualified",    "IsActive": true  },  {    "StageID": 3,    "Name": "Closed Won",    "IsActive": true  } ]  

โŒ Error Responses

Code Message Description
401 Unauthorized Missing or invalid bearer token.
500 Internal Server Error Unexpected server-side failure.