Get an Opportunity by Id
Returns the details of a single Opportunity Type in your account. You can get theOpportunityId
for an opportunity by referring to Get Opportunity by Lead Id.
API URL
URL Parameters
Parameter | Description |
---|---|
OpportunityId | Opportunity Id of the opportunity you want to retrieve the details for. This is mandatory. |
getFileURL | Retrieves the URLs for files that are uploaded to a CFS present within the opportunity. This is optional. To retrieve the file URLs, pass the value as "true" |
Response
HTTP Response Codes
Code | Description |
---|---|
200 OK | This is the status code for successful API call. |
401 Unauthorized | The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
400 Bad Request | The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
404 Not Found | The API could not be found. Please check the API signature. |
429 Too Many Requests | API calls exceeded the limit of 25 in 5 second(s) |
500 Internal Server Error | The API called failed. There could be many reasons for it. Check the exception message to get more details. |