Opportunities / Statuses
Get Opportunity Status
This endpoint retrieves data of a specific Opportunity Status based on JSON input. The API returns a single Opportunity Status available to the user in the Value List, according to the unique ID provided. If the specified Opportunity Status does not exist, the response will be a "bad request".
You will only receive the Opportunity Status 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 Status |
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| branchVisibility | Object, Null | In which Branch the Opportunity Status is visible |
| endStatus | Integer | Set to 1 if the Opportunity is closed 0 otherwise |
| won | Boolean | If true, the close opportunity has been won |
| idParent | Integer | This is mostly used to stick an Opportunity Status with an Opportunity Type (see Types resource), in the case the Opportunity Types are used to represent multiple pipelines |
| dateCreated | String | Date and time when the Opportunity Status was created |
| dateDeleted | String | Date and time when the Opportunity Status was deleted |
| dateUpdated | String | Date and time when the Opportunity Status was last updated |
| deleted | Boolean | If true, the Opportunity Status has been deleted and archived |
| descriptionDE | String | Opportunity Status label in German |
| descriptionDK | String | Opportunity Status label in Dutch |
| descriptionEN (Required) | String | Opportunity Status label in English |
| descriptionES | String | Opportunity Status label in Spanish |
| descriptionFR | String | Opportunity Status label in French |
| descriptionIT | String | Opportunity Status label in Italian |
| descriptionPT | String | Opportunity Status label in Portuguese |
| descriptionRU | String | Opportunity Status label in Russian |
| descriptionUS | String | Opportunity Status label in American English |
| id | Integer | Unique identifier for the Opportunity Status in ForceManager |
| order | Integer | The position of the Opportunity Status in the Opportunity Statuses value list |
| salesRepIdCreated | Integer | Unique identifier of the user who created the Opportunity Status |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Opportunity Status |
| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Opportunity Status |
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/opportunityStatuses/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/opportunityStatuses/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Response
Get Opportunity Status
Changes
No recorded changes to this operation across all 1 revision of this API.