Appearance
Get an opportunity
GET
/api/nova/opportunities/{opportunityId}
Fetches a single opportunity by its identifier. The response includes the name, description, probability, forecasted and actual closing dates, start date, estimated duration in months, the linked company and contact, the current state with its reason, and the bid value with currency. Returns 404 when no opportunity exists with the given id and 401 if the API key is invalid.
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Path Parameters
opportunityId*
opportunityId
Type
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Responses
OK
application/json
JSON "data": { "actualClosingDate": "string", "bidCurrency": "string", "bidValue": 0, "companyId": "string", "companyName": "string", "contactId": "string", "contactName": "string", "createdOn": "string", "customFields": [ { "boolValue": "string", "dateValue": "string", "fieldId": "string", "fieldLabel": "string", "listValue": [ "string" ], "value": "string" } ], "description": "string", "employmentTypeId": "string", "employmentTypeName": "string", "estimatedDurationMonths": 0, "forecastedClosingDate": "string", "id": "string", "name": "string", "ownerId": "string", "ownerName": "string", "probability": 0, "reference": "string", "startDate": "string", "stateId": "string", "stateName": "string", "stateReason": "string", "statusId": "string", "statusName": "string", "tags": [ { "group": "string", "value": "string" } ], "updatedOn": "string" }, "error": "string", "message": "string", "requestId": "string", "success": true
{
}