.png){kind=logo}
List Opportunity Categories
🧾 List Opportunity Categories
Endpoint: GET /api/v3/opportunity-categories
Auth Required: ✅ Yes (Bearer Token)
📝 Description
Returns a list of opportunity categories available in the system. These categories help organize opportunities by business focus, product line, or strategic segment. Typically used for filtering, reporting, or form inputs during opportunity creation.
🔍 Query Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
includeInactive |
boolean | No | — | If true, includes inactive categories. |
languageId |
integer | No | — | Language ID for localized category names. |
📤 Request Example
GET https://api.briefingedge.com/api/v3/opportunity-categories?includeInactive=false&languageId=1 Authorization: Bearer <token>
✅ Success Response (200 OK)
Returns an array of OpportunityCategory objects.
Example:
[ { "CategoryID": 1, "Name": "New Business", "IsActive": true }, { "CategoryID": 2, "Name": "Expansion", "IsActive": true } ]
❌ Error Responses
| Code | Message | Description |
|---|---|---|
| 401 | Unauthorized | Missing or invalid bearer token. |
| 500 | Internal Server Error | Unexpected server-side failure. |