GET v1/opportunities/types

Gets list of opportunity types along with stages associated to those types.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of OpportunityType

Name	Description	Type	Additional information
Id	ID of the Opportunity Type	integer	None.
Name	Name of the Opportunity Type	string	None.
Stages	Stages available within the Opportunity Type	Collection of OpportunityStage	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "name": "sample string 2",
    "stages": [
      {
        "id": 1,
        "name": "sample string 2",
        "isDefault": true,
        "visibleOnBoard": true
      },
      {
        "id": 1,
        "name": "sample string 2",
        "isDefault": true,
        "visibleOnBoard": true
      }
    ]
  },
  {
    "id": 1,
    "name": "sample string 2",
    "stages": [
      {
        "id": 1,
        "name": "sample string 2",
        "isDefault": true,
        "visibleOnBoard": true
      },
      {
        "id": 1,
        "name": "sample string 2",
        "isDefault": true,
        "visibleOnBoard": true
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfOpportunityType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.CRM">
  <OpportunityType>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <Stages>
      <OpportunityStage>
        <Id>1</Id>
        <IsDefault>true</IsDefault>
        <Name>sample string 2</Name>
        <VisibleOnBoard>true</VisibleOnBoard>
      </OpportunityStage>
      <OpportunityStage>
        <Id>1</Id>
        <IsDefault>true</IsDefault>
        <Name>sample string 2</Name>
        <VisibleOnBoard>true</VisibleOnBoard>
      </OpportunityStage>
    </Stages>
  </OpportunityType>
  <OpportunityType>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <Stages>
      <OpportunityStage>
        <Id>1</Id>
        <IsDefault>true</IsDefault>
        <Name>sample string 2</Name>
        <VisibleOnBoard>true</VisibleOnBoard>
      </OpportunityStage>
      <OpportunityStage>
        <Id>1</Id>
        <IsDefault>true</IsDefault>
        <Name>sample string 2</Name>
        <VisibleOnBoard>true</VisibleOnBoard>
      </OpportunityStage>
    </Stages>
  </OpportunityType>
</ArrayOfOpportunityType>