Opportunities / Entity
Get Opportunity
This endpoint retrieves data of a specific Opportunity based on JSON input. The API returns a single Opportunity available to the user, according to the unique ID provided. If the specified Opportunity does not exist, the response will be a "bad request".
You will only receive the Opportunity after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
HEADERS
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | */* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
REQUEST
| Parameter | Type | Description |
|---|---|---|
| id | Integer | The unique and specific identifier of the Opportunity |
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| accountId1 | Object, Null | First Account to whom the Opportunity is linked to (see Accounts resource) |
| accountId2 | Object, Null | Second Account to whom the Opportunity is linked to (see Accounts resource) |
| accountId3 | Object, Null | Third Account to whom the Opportunity is linked to (see Accounts resource) |
| address1 | String | First address to whom the Opportunity is linked |
| address2 | String | Second address to whom the Opportunity is linked |
| branchId | Object, Null | Branch to whom the Opportunity has been assigned (see Branches resource) |
| city | String | City name |
| closedDate | String | Date when the Opportunity was closed |
| comments | String | Comment added to the Opportunity |
| countryId | Object, Null | Country ID (see Countries resource) of the Opportunity address |
| currencyId | Object, Null | Currency ID (see Currencies resource) related to the Opportunity amount |
| dateCreated | String | Date and time when the Opportunity was created |
| dateDeleted | String | Date and time when the Opportunity was deleted |
| dateUpdated | String | Date and time when the Opportunity was last updated |
| deleted | Boolean | If true, the Opportunity has been deleted and archived |
| extId | String | External ID of the Opportunity from a third party system (ERP, CRM, Accounting System) |
| geocoded | Boolean | If true, the Opportunity has been geolocated |
| geocodingAccuracy | Integer | Accuracy radius based on information about cell towers and WiFi nodes that the mobile client can detect |
| id | Integer | Unique identifier for the Opportunity in ForceManager |
| latitude | Number | Geocode address for the latitude coordinates |
| longitude | Number | Geocode address for the longitude coordinates |
| lostDate | String | Date when the Opportunity was lost |
| permissionLevel | String | Defines the visibility of the Opportunity. Set from 1 to 5 being 5 the highest level of permission |
| postcode | String | The Opportunity's address postal code |
| readOnly | Boolean | If true, the Opportunity can not be modified or deleted |
| reference | String | Opportunity's name |
| region | String | Region/State name |
| salesForeCastDate | String | Forecast sale date |
| salesProbability | Object, Null | Probability of sale |
| salesRepId | Object, Null | Unique identifier of the User associated to the Opportunity (see Users resource) |
| salesRepIdCreated | Integer | Unique identifier of the User who created the Opportunity |
| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Opportunity |
| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Opportunity |
| type_id | Object, Null | Type of the Opportunity (see Types resource) |
| statusId | Object, Null | Status of the Opportunity (see Statues resource) |
| total | Number | Total amount of the Opportunity |
| wonDate | String | Date when the Opportunity was won |
RESPONSE CODES
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
get/opportunities/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/opportunities/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
X-FM-Entity-Countstring
Response
Get Opportunity
Changes
No recorded changes to this operation across all 1 revision of this API.