Get opportunities

Retrieves the properties and relationships of an opportunity object for Business Central.

HTTP request

Replace the URL prefix for Business Central depending on environment following the guideline.

GET businesscentralPrefix/companies({id})/opportunities({id})

Request headers

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and an opportunity object in the response body.

Example

Request

Here's an example of the request.

GET https://{businesscentralPrefix}/api/v2.0/companies({id})/opportunities({id})

Response

Here's an example of the response.

200 OK
{
"@odata.etag": "W/\"JzQ0OzZXc0ZDVjlUYjBOTDNOYmMvbjdTSTNpRWlhVjVXbmRBUzltakJOYmFlTU09MTswMDsn\"",
"id": "2438bf05-52ff-eb11-bb76-000d3a220646",
"number": "OP100001",
"contactNumber": "CT200116",
"contactName": "David Oliver Lawrence",
"contactCompanyName": "A. Gibson\"s Law Firm",
"salespersonCode": "BC",
"description": "New tables",
"status": "In_x0020_Progress",
"closed": false,
"creationDate": "2022-11-05",
"dateClosed": "0001-01-01",
"calculatedCurrentValue": 600,
"chancesOfSuccessPrc": 15,
"completedPrc": 2,
"estimatedClosingDate": "2023-11-11",
"estimatedValue": 200000,
"systemCreatedAt": "2021-08-17T11:55:35.327Z",
"lastModifiedDateTime": "2021-08-17T11:55:35.327Z"
}

Related information

Tips for working with the APIs
opportunity
DELETE opportunity
POST opportunity
PATCH opportunity