TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

GET api/2.0/crm/opportunity/stage/{stageid} This function requires authentication

Description

Returns an opportunity stage with the ID specified in the request.

Parameters
Name Description Type Example
stageid
sent in url
Opportunity stage ID number 1234
Example
GET api/2.0/crm/opportunity/stage/1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Opportunity stage

Example Response

application/json

{
  "status": 0,
  "response": {
    "RelativeItemsCount": 1,
    "id": 1234,
    "Title": "Title",
    "Description": "Description",
    "Color": "#a7fc00",
    "SortOrder": 1,
    "SuccessProbability": 20,
    "StageType": 0
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <RelativeItemsCount>1</RelativeItemsCount>
    <id>1234</id>
    <Title>Title</Title>
    <Description>Description</Description>
    <Color>#a7fc00</Color>
    <SortOrder>1</SortOrder>
    <SuccessProbability>20</SuccessProbability>
    <StageType>0</StageType>
  </response>
</result>