GET api/Company/GetCompanyByName

Returns the company based upon the company's name. Will return an empty object if not found. Use ?companyName={companyName} in querystring Add industryid to querystring for tracking purposes if necessary/possible Set track=false (added to the querystring) if you don't want to auto track the company details.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

CompanyAll
NameDescriptionTypeAdditional information
company

Companies

None.
companyindustries

Collection of Company2IndustryAll

None.

Response Formats

application/json, text/json, text/html

Sample: 
{
  "company": {
    "Id": 1,
    "Name": "sample string 2",
    "Type": 3,
    "Website": "sample string 4",
    "Overview": "sample string 5",
    "Regions": 6,
    "Logo": "sample string 7",
    "Enabled": true,
    "OverallCA": 9,
    "OverallCP": 10,
    "AccessLevel": 11,
    "Display": true,
    "Tagline": "sample string 13",
    "Headquarters": "sample string 14",
    "Employees": "sample string 15",
    "Ticker": "sample string 16",
    "Revenue": "sample string 17",
    "RecentHappenings": "sample string 18",
    "NumPipeLineDrugs": 19,
    "PipeLineDrugs": "sample string 20",
    "EntityType": 21,
    "Phone": "sample string 22",
    "OldImportId": 23,
    "SubscriptionIndustryId": 24,
    "SubscriptionSegmentId": 25,
    "MemberSince": "2024-10-30T05:09:21.6747845-07:00",
    "DemoMode": true,
    "Ownership": 0,
    "Email": "sample string 28",
    "SocialMedia": "sample string 29"
  },
  "companyindustries": [
    {
      "i": {
        "IndustryId": 1,
        "IndustryName": "sample string 2",
        "CompanyAlphaSet": "sample string 3",
        "LongTitle": "sample string 4",
        "InheritSectorsFrom": 5
      },
      "c": {
        "Company2IndustryId": 1,
        "Companyid": 2,
        "IndustryId": 3,
        "OverallCP": 4,
        "OverallCA": 5,
        "Type": 6
      }
    },
    {
      "i": {
        "IndustryId": 1,
        "IndustryName": "sample string 2",
        "CompanyAlphaSet": "sample string 3",
        "LongTitle": "sample string 4",
        "InheritSectorsFrom": 5
      },
      "c": {
        "Company2IndustryId": 1,
        "Companyid": 2,
        "IndustryId": 3,
        "OverallCP": 4,
        "OverallCA": 5,
        "Type": 6
      }
    }
  ]
}

application/xml, text/xml

Sample: 
<CompanyAll xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NiceAPI.Managers">
  <company>
    <AccessLevel>11</AccessLevel>
    <DemoMode>true</DemoMode>
    <Display>true</Display>
    <Email>sample string 28</Email>
    <Employees>sample string 15</Employees>
    <Enabled>true</Enabled>
    <EntityType>21</EntityType>
    <Headquarters>sample string 14</Headquarters>
    <Id>1</Id>
    <Logo>sample string 7</Logo>
    <MemberSince>2024-10-30T05:09:21.6747845-07:00</MemberSince>
    <Name>sample string 2</Name>
    <NumPipeLineDrugs>19</NumPipeLineDrugs>
    <OldImportId>23</OldImportId>
    <OverallCA>9</OverallCA>
    <OverallCP>10</OverallCP>
    <Overview>sample string 5</Overview>
    <Ownership>Unset</Ownership>
    <Phone>sample string 22</Phone>
    <PipeLineDrugs>sample string 20</PipeLineDrugs>
    <RecentHappenings>sample string 18</RecentHappenings>
    <Regions>6</Regions>
    <Revenue>sample string 17</Revenue>
    <SocialMedia>sample string 29</SocialMedia>
    <SubscriptionIndustryId>24</SubscriptionIndustryId>
    <SubscriptionSegmentId>25</SubscriptionSegmentId>
    <Tagline>sample string 13</Tagline>
    <Ticker>sample string 16</Ticker>
    <Type>3</Type>
    <Website>sample string 4</Website>
  </company>
  <companyindustries>
    <Company2IndustryAll>
      <c>
        <Company2IndustryId>1</Company2IndustryId>
        <Companyid>2</Companyid>
        <IndustryId>3</IndustryId>
        <OverallCA>5</OverallCA>
        <OverallCP>4</OverallCP>
        <Type>6</Type>
      </c>
      <i>
        <CompanyAlphaSet>sample string 3</CompanyAlphaSet>
        <IndustryId>1</IndustryId>
        <IndustryName>sample string 2</IndustryName>
        <InheritSectorsFrom>5</InheritSectorsFrom>
        <LongTitle>sample string 4</LongTitle>
      </i>
    </Company2IndustryAll>
    <Company2IndustryAll>
      <c>
        <Company2IndustryId>1</Company2IndustryId>
        <Companyid>2</Companyid>
        <IndustryId>3</IndustryId>
        <OverallCA>5</OverallCA>
        <OverallCP>4</OverallCP>
        <Type>6</Type>
      </c>
      <i>
        <CompanyAlphaSet>sample string 3</CompanyAlphaSet>
        <IndustryId>1</IndustryId>
        <IndustryName>sample string 2</IndustryName>
        <InheritSectorsFrom>5</InheritSectorsFrom>
        <LongTitle>sample string 4</LongTitle>
      </i>
    </Company2IndustryAll>
  </companyindustries>
</CompanyAll>