Read Opportunity by ID

๐Ÿงพ Read Opportunity by ID

Endpoint: GET /api/v3/opportunities/{opportunityId}

Auth Required: โœ… Yes (Bearer Token)


๐Ÿ“ Description

Retrieves the full details of a single opportunity by its unique ID. Typically used when viewing opportunity details, editing data, or linking from dashboards and reports.


๐Ÿ”ข URL Parameters

Parameter Type Required Description
opportunityId integer/string โœ… Yes Unique identifier of the opportunity.

๐Ÿ” Query Parameters

None.


๐Ÿ“ค Request Example

GET https://api.briefingedge.com/api/v3/opportunities/1001 Authorization: Bearer <token>  

โœ… Success Response (200 OK)

Returns the requested Opportunity object.

Example:

{  "OpportunityID": 1001,  "Name": "Acme Expansion",  "StageID": 3,  "ExpectedCloseDate": "2025-10-01",  "Status": "Open" }  

โŒ Error Responses

Code Message Description
401 Unauthorized Missing or invalid bearer token.
404 Not Found No opportunity found with the given ID.
500 Internal Server Error Unexpected server-side failure.