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/bycontact/{contactid} This function requires authentication

Description

Returns a list of all the opportunities for the contact with the ID specified in the request.

Parameters
Name Description Type Example
contactid
sent in url
Contact ID
optional
number 1234
Example
GET api/2.0/crm/opportunity/bycontact/1234
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": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      },
      "Created": "2020-12-11T03:36:09.7011881Z",
      "Members": [
        {
          "SmallFotoUrl": "url to foto",
          "MediumFotoUrl": "url to foto",
          "DisplayName": "Tadjeddine Bachir",
          "IsCompany": false,
          "AccessList": [
            {
              "Id": "00000000-0000-0000-0000-000000000000",
              "DisplayName": "Mike Zanyatski",
              "Title": "Manager",
              "AvatarSmall": "url to small avatar",
              "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
            }
          ],
          "IsPrivate": true,
          "IsShared": false,
          "ShareType": 0,
          "Currency": {
            "Title": "Chinese Yuan",
            "Symbol": "¥",
            "Abbreviation": "CNY",
            "CultureName": "CN",
            "IsConvertable": true,
            "IsBasic": false
          },
          "CanEdit": true,
          "CanDelete": true,
          "id": 1234
        }
      ],
      "Contact": {
        "SmallFotoUrl": "url to foto",
        "MediumFotoUrl": "url to foto",
        "DisplayName": "Tadjeddine Bachir",
        "IsCompany": false,
        "AccessList": [
          {
            "Id": "00000000-0000-0000-0000-000000000000",
            "DisplayName": "Mike Zanyatski",
            "Title": "Manager",
            "AvatarSmall": "url to small avatar",
            "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
          }
        ],
        "IsPrivate": true,
        "IsShared": false,
        "ShareType": 0,
        "Currency": {
          "Title": "Chinese Yuan",
          "Symbol": "¥",
          "Abbreviation": "CNY",
          "CultureName": "CN",
          "IsConvertable": true,
          "IsBasic": false
        },
        "CanEdit": true,
        "CanDelete": true,
        "id": 1234
      },
      "Title": "Hotel catalogue",
      "Description": "description",
      "Responsible": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "DisplayName": "Mike Zanyatski",
        "Title": "Manager",
        "AvatarSmall": "url to small avatar",
        "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      },
      "BidType": 0,
      "BidValue": 11.0,
      "BidCurrency": {
        "Title": "Chinese Yuan",
        "Symbol": "¥",
        "Abbreviation": "CNY",
        "CultureName": "CN",
        "IsConvertable": true,
        "IsBasic": false
      },
      "PerPeriodValue": 1,
      "Stage": {
        "SuccessProbability": 20,
        "StageType": 0,
        "id": 1234,
        "Title": "Title",
        "Description": "Description",
        "Color": "#a7fc00",
        "SortOrder": 1
      },
      "SuccessProbability": 65,
      "ActualCloseDate": "2020-12-11T03:36:09.7011881Z",
      "ExpectedCloseDate": "2020-12-11T03:36:09.7011881Z",
      "IsPrivate": false,
      "AccessList": [
        {
          "Id": "00000000-0000-0000-0000-000000000000",
          "DisplayName": "Mike Zanyatski",
          "Title": "Manager",
          "AvatarSmall": "url to small avatar",
          "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
        }
      ],
      "CanEdit": true,
      "CustomFields": [
        {
          "EntityId": 14523423,
          "Label": "Birthdate",
          "FieldValue": "2020-12-08T17:37:04.5916406Z",
          "FieldType": 5,
          "Position": 10,
          "Mask": "",
          "id": 1234
        }
      ],
      "id": 1234
    }
  ]
}

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>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </CreateBy>
    <Created>2020-12-11T03:36:09.7011881Z</Created>
    <Members>
      <SmallFotoUrl>url to foto</SmallFotoUrl>
      <MediumFotoUrl>url to foto</MediumFotoUrl>
      <DisplayName>Tadjeddine Bachir</DisplayName>
      <IsCompany>False</IsCompany>
      <AccessList>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <DisplayName>Mike Zanyatski</DisplayName>
        <Title>Manager</Title>
        <AvatarSmall>url to small avatar</AvatarSmall>
        <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
      </AccessList>
      <IsPrivate>True</IsPrivate>
      <IsShared>False</IsShared>
      <ShareType>0</ShareType>
      <Currency>
        <Title>Chinese Yuan</Title>
        <Symbol>¥</Symbol>
        <Abbreviation>CNY</Abbreviation>
        <CultureName>CN</CultureName>
        <IsConvertable>True</IsConvertable>
        <IsBasic>False</IsBasic>
      </Currency>
      <CanEdit>True</CanEdit>
      <CanDelete>True</CanDelete>
      <id>1234</id>
    </Members>
    <Contact>
      <SmallFotoUrl>url to foto</SmallFotoUrl>
      <MediumFotoUrl>url to foto</MediumFotoUrl>
      <DisplayName>Tadjeddine Bachir</DisplayName>
      <IsCompany>False</IsCompany>
      <AccessList>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <DisplayName>Mike Zanyatski</DisplayName>
        <Title>Manager</Title>
        <AvatarSmall>url to small avatar</AvatarSmall>
        <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
      </AccessList>
      <IsPrivate>True</IsPrivate>
      <IsShared>False</IsShared>
      <ShareType>0</ShareType>
      <Currency>
        <Title>Chinese Yuan</Title>
        <Symbol>¥</Symbol>
        <Abbreviation>CNY</Abbreviation>
        <CultureName>CN</CultureName>
        <IsConvertable>True</IsConvertable>
        <IsBasic>False</IsBasic>
      </Currency>
      <CanEdit>True</CanEdit>
      <CanDelete>True</CanDelete>
      <id>1234</id>
    </Contact>
    <Title>Hotel catalogue</Title>
    <Description>description</Description>
    <Responsible>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </Responsible>
    <BidType>0</BidType>
    <BidValue>11</BidValue>
    <BidCurrency>
      <Title>Chinese Yuan</Title>
      <Symbol>¥</Symbol>
      <Abbreviation>CNY</Abbreviation>
      <CultureName>CN</CultureName>
      <IsConvertable>True</IsConvertable>
      <IsBasic>False</IsBasic>
    </BidCurrency>
    <PerPeriodValue>1</PerPeriodValue>
    <Stage>
      <SuccessProbability>20</SuccessProbability>
      <StageType>0</StageType>
      <id>1234</id>
      <Title>Title</Title>
      <Description>Description</Description>
      <Color>#a7fc00</Color>
      <SortOrder>1</SortOrder>
    </Stage>
    <SuccessProbability>65</SuccessProbability>
    <ActualCloseDate>2020-12-11T03:36:09.7011881Z</ActualCloseDate>
    <ExpectedCloseDate>2020-12-11T03:36:09.7011881Z</ExpectedCloseDate>
    <IsPrivate>False</IsPrivate>
    <AccessList>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </AccessList>
    <CanEdit>True</CanEdit>
    <CustomFields>
      <EntityId>14523423</EntityId>
      <Label>Birthdate</Label>
      <FieldValue>2020-12-08T17:37:04.5916406Z</FieldValue>
      <FieldType>5</FieldType>
      <Position>10</Position>
      <Mask />
      <id>1234</id>
    </CustomFields>
    <id>1234</id>
  </response>
</result>