Get Started
Usage API
More information

GET api/2.0/crm/opportunity/filter This function requires authentication

Description

Returns a list of all the opportunities matching the parameters specified in the request.

Parameters
Name Description Type Example
responsibleid
sent in url
Opportunity responsible ID
optional
guid 9924256A-739C-462b-AF15-E652A3B1B6EB
opportunityStagesid
sent in url
Opportunity stage ID
optional
number 1234
tags
sent in url
Opportunity tags
optional
Collection of strings
collection
some text
contactid
sent in url
Contact ID
optional
number 1234
contactAlsoIsParticipant
sent in url
Participation status: take into account opportunities where the contact is a participant or not
optional
Bool value true
fromDate
sent in url
Start date
optional
Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
toDate
sent in url
End date
optional
Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
stageType
sent in url
Opportunity stage type
Allowed values: {Open, ClosedAndWon, ClosedAndLost}
optional
ASC.CRM.Core.DealMilestoneStatus
Example
GET api/2.0/crm/opportunity/filter?responsibleid=9924256A-739C-462b-AF15-E652A3B1B6EB&opportunityStagesid=1234&tags=%5b%22some+text%22%5d&contactid=1234&fromDate=2008-04-10T06-30-00.000Z&toDate=2008-04-10T06-30-00.000Z
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of opportunities

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "createBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "created": "2021-10-27T14:55:38.3749069Z",
      "contact": {
        "smallFotoUrl": "url to foto",
        "displayName": "Tadjeddine Bachir",
        "isCompany": false,
        "isPrivate": true,
        "isShared": false,
        "shareType": 0,
        "currency": null,
        "canEdit": false,
        "canDelete": false,
        "id": 0
      },
      "title": "Hotel catalogue",
      "description": "",
      "responsible": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "stage": {
        "successProbability": 20,
        "stageType": 0,
        "title": "Discussion",
        "description": "The potential buyer showed his\/her interest and sees how your offering meets his\/her goal",
        "color": "#B9AFD3",
        "sortOrder": 2,
        "id": 30
      },
      "successProbability": 65,
      "expectedCloseDate": "2021-10-27T14:55:38.3749069Z",
      "isPrivate": false,
      "canEdit": false,
      "id": 0
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <createBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </createBy>
    <created>2021-10-27T14:55:38.3749069Z</created>
    <contact>
      <smallFotoUrl>url to foto</smallFotoUrl>
      <displayName>Tadjeddine Bachir</displayName>
      <isCompany>false</isCompany>
      <isPrivate>true</isPrivate>
      <isShared>false</isShared>
      <shareType>0</shareType>
      <currency />
      <canEdit>false</canEdit>
      <canDelete>false</canDelete>
      <id>0</id>
    </contact>
    <title>Hotel catalogue</title>
    <description></description>
    <responsible>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </responsible>
    <stage>
      <successProbability>20</successProbability>
      <stageType>0</stageType>
      <title>Discussion</title>
      <description>The potential buyer showed his/her interest and sees how your offering meets his/her goal</description>
      <color>#B9AFD3</color>
      <sortOrder>2</sortOrder>
      <id>30</id>
    </stage>
    <successProbability>65</successProbability>
    <expectedCloseDate>2021-10-27T14:55:38.3749069Z</expectedCloseDate>
    <isPrivate>false</isPrivate>
    <canEdit>false</canEdit>
    <id>0</id>
  </response>
</result>